function FormatterBase::settingsForm

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::settingsForm()
  2. 10 core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::settingsForm()
  3. 11.x core/lib/Drupal/Core/Field/FormatterBase.php \Drupal\Core\Field\FormatterBase::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.

Overrides FormatterInterface::settingsForm

13 calls to FormatterBase::settingsForm()
AggregatorTitleFormatter::settingsForm in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php
Returns a form to configure settings for the formatter.
BaseFieldFileFormatterBase::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php
Returns a form to configure settings for the formatter.
BooleanFormatter::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php
Returns a form to configure settings for the formatter.
DateTimeFormatterBase::settingsForm in core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php
Returns a form to configure settings for the formatter.
DescriptionAwareFileFormatterBase::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/DescriptionAwareFileFormatterBase.php
Returns a form to configure settings for the formatter.

... See full list

25 methods override FormatterBase::settingsForm()
AggregatorTitleFormatter::settingsForm in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php
Returns a form to configure settings for the formatter.
BaseFieldFileFormatterBase::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php
Returns a form to configure settings for the formatter.
BooleanFormatter::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php
Returns a form to configure settings for the formatter.
CommentDefaultFormatter::settingsForm in core/modules/comment/src/Plugin/Field/FieldFormatter/CommentDefaultFormatter.php
Returns a form to configure settings for the formatter.
DateTimeFormatterBase::settingsForm in core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php
Returns a form to configure settings for the formatter.

... See full list

File

core/lib/Drupal/Core/Field/FormatterBase.php, line 124

Class

FormatterBase
Base class for 'Field formatter' plugin implementations.

Namespace

Drupal\Core\Field

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  return [];
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.