function WidgetInterface::settingsForm

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::settingsForm()
  2. 10 core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::settingsForm()
  3. 11.x core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::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.

1 method overrides WidgetInterface::settingsForm()
WidgetBase::settingsForm in core/lib/Drupal/Core/Field/WidgetBase.php
Returns a form to configure settings for the widget.

File

core/lib/Drupal/Core/Field/WidgetInterface.php, line 35

Class

WidgetInterface
Interface definition for field widget plugins.

Namespace

Drupal\Core\Field

Code

public function settingsForm(array $form, FormStateInterface $form_state);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.