public function DateTimeFormatterBase::settingsForm in Drupal 9
Same name and namespace in other branches
- 8 core/modules/datetime/src/Plugin/Field/FieldFormatter/DateTimeFormatterBase.php \Drupal\datetime\Plugin\Field\FieldFormatter\DateTimeFormatterBase::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
3 calls to DateTimeFormatterBase::settingsForm()
- DateRangePlainFormatter::settingsForm in core/
modules/ datetime_range/ src/ Plugin/ Field/ FieldFormatter/ DateRangePlainFormatter.php - Returns a form to configure settings for the formatter.
- DateTimeCustomFormatter::settingsForm in core/
modules/ datetime/ src/ Plugin/ Field/ FieldFormatter/ DateTimeCustomFormatter.php - Returns a form to configure settings for the formatter.
- DateTimeDefaultFormatter::settingsForm in core/
modules/ datetime/ src/ Plugin/ Field/ FieldFormatter/ DateTimeDefaultFormatter.php - Returns a form to configure settings for the formatter.
3 methods override DateTimeFormatterBase::settingsForm()
- DateRangePlainFormatter::settingsForm in core/
modules/ datetime_range/ src/ Plugin/ Field/ FieldFormatter/ DateRangePlainFormatter.php - Returns a form to configure settings for the formatter.
- DateTimeCustomFormatter::settingsForm in core/
modules/ datetime/ src/ Plugin/ Field/ FieldFormatter/ DateTimeCustomFormatter.php - Returns a form to configure settings for the formatter.
- DateTimeDefaultFormatter::settingsForm in core/
modules/ datetime/ src/ Plugin/ Field/ FieldFormatter/ DateTimeDefaultFormatter.php - Returns a form to configure settings for the formatter.
File
- core/
modules/ datetime/ src/ Plugin/ Field/ FieldFormatter/ DateTimeFormatterBase.php, line 93
Class
- DateTimeFormatterBase
- Base class for 'DateTime Field formatter' plugin implementations.
Namespace
Drupal\datetime\Plugin\Field\FieldFormatterCode
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$form['timezone_override'] = [
'#type' => 'select',
'#title' => $this
->t('Time zone override'),
'#description' => $this
->t('The time zone selected here will always be used'),
'#options' => system_time_zones(TRUE, TRUE),
'#default_value' => $this
->getSetting('timezone_override'),
];
return $form;
}