Same name in other branches

1. 9 core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::settingsForm()
2. 8.9.x core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::settingsForm()
3. 10 core/lib/Drupal/Core/Field/FormatterInterface.php \Drupal\Core\Field\FormatterInterface::settingsForm()

Returns a form to configure settings for the formatter.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for the formatter settings.

1 method overrides FormatterInterface::settingsForm()

FormatterBase::settingsForm in core/lib/Drupal/Core/Field/FormatterBase.php

Returns a form to configure settings for the formatter.

File

core/lib/Drupal/Core/Field/FormatterInterface.php, line 29

Class

FormatterInterface

Interface definition for field formatter plugins.

Namespace

Drupal\Core\Field

Code

public function settingsForm(array $form, FormStateInterface $form_state);

---