function WidgetBase::settingsForm

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Field/WidgetBase.php \Drupal\Core\Field\WidgetBase::settingsForm()
  2. 10 core/lib/Drupal/Core/Field/WidgetBase.php \Drupal\Core\Field\WidgetBase::settingsForm()
  3. 8.9.x core/lib/Drupal/Core/Field/WidgetBase.php \Drupal\Core\Field\WidgetBase::settingsForm()

Returns a form to configure settings for the widget.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the widget. 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 definition for the widget settings.

Overrides WidgetInterface::settingsForm

4 calls to WidgetBase::settingsForm()
DateRangeDatelistWidget::settingsForm in core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeDatelistWidget.php
Returns a form to configure settings for the widget.
DateTimeDatelistWidget::settingsForm in core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeDatelistWidget.php
Returns a form to configure settings for the widget.
LanguageSelectWidget::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/LanguageSelectWidget.php
Returns a form to configure settings for the widget.
LinkWidget::settingsForm in core/modules/link/src/Plugin/Field/FieldWidget/LinkWidget.php
Returns a form to configure settings for the widget.
16 methods override WidgetBase::settingsForm()
BooleanCheckboxWidget::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php
Returns a form to configure settings for the widget.
DateRangeDatelistWidget::settingsForm in core/modules/datetime_range/src/Plugin/Field/FieldWidget/DateRangeDatelistWidget.php
Returns a form to configure settings for the widget.
DateTimeDatelistWidget::settingsForm in core/modules/datetime/src/Plugin/Field/FieldWidget/DateTimeDatelistWidget.php
Returns a form to configure settings for the widget.
EmailDefaultWidget::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EmailDefaultWidget.php
Returns a form to configure settings for the widget.
EntityReferenceAutocompleteWidget::settingsForm in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php
Returns a form to configure settings for the widget.

... See full list

File

core/lib/Drupal/Core/Field/WidgetBase.php, line 527

Class

WidgetBase
Base class for 'Field widget' 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.