public function BooleanCheckboxWidget::settingsForm in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\BooleanCheckboxWidget::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 WidgetBase::settingsForm

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php, line 35

Class

BooleanCheckboxWidget

Plugin implementation of the 'boolean_checkbox' widget.

Namespace

Drupal\Core\Field\Plugin\Field\FieldWidget

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element['display_label'] = [
    '#type' => 'checkbox',
    '#title' => t('Use field label instead of the "On" label as the label.'),
    '#default_value' => $this
      ->getSetting('display_label'),
    '#weight' => -1,
  ];
  return $element;
}