You are here

public function TestFieldDefaultFormatter::settingsForm in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldDefaultFormatter.php \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldDefaultFormatter::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 FormatterBase::settingsForm

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldDefaultFormatter.php, line 37

Class

TestFieldDefaultFormatter
Plugin implementation of the 'field_test_default' formatter.

Namespace

Drupal\field_test\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element['test_formatter_setting'] = [
    '#title' => t('Setting'),
    '#type' => 'textfield',
    '#size' => 20,
    '#default_value' => $this
      ->getSetting('test_formatter_setting'),
    '#required' => TRUE,
  ];
  return $element;
}