public function DateTimeCustomFormatter::settingsForm in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter::settingsForm()
2. 9 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeCustomFormatter::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 DateTimeFormatterBase::settingsForm

1 method overrides DateTimeCustomFormatter::settingsForm()

DateRangeCustomFormatter::settingsForm in core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php

Returns a form to configure settings for the formatter.

File

core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeCustomFormatter.php, line 65

Class

DateTimeCustomFormatter

Plugin implementation of the 'Custom' formatter for 'datetime' fields.

Namespace

Drupal\datetime\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['date_format'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Date/time format'),
    '#description' => $this
      ->t('See <a href="https://www.php.net/manual/datetime.format.php#refsect1-datetime.format-parameters" target="_blank">the documentation for PHP date formats</a>.'),
    '#default_value' => $this
      ->getSetting('date_format'),
  ];
  return $form;
}