public function UserNameFormatter::settingsForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php \Drupal\user\Plugin\Field\FieldFormatter\UserNameFormatter::settingsForm()
2. 10 core/modules/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php \Drupal\user\Plugin\Field\FieldFormatter\UserNameFormatter::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/user/src/Plugin/Field/FieldFormatter/UserNameFormatter.php, line 37

Class

UserNameFormatter

Plugin implementation of the 'user_name' formatter.

Namespace

Drupal\user\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['link_to_entity'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Link to the user'),
    '#default_value' => $this
      ->getSetting('link_to_entity'),
  ];
  return $form;
}