function FieldItemList::defaultValuesFormSubmit

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

Processes the submitted default value.

Invoked from \Drupal\field_ui\Form\FieldConfigEditForm to allow administrators to configure instance-level default value.

Parameters

array $element: The default value form element.

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The form state of the (entire) configuration form.

Return value

array The field default value.

Overrides FieldItemListInterface::defaultValuesFormSubmit

1 call to FieldItemList::defaultValuesFormSubmit()
EntityReferenceFieldItemList::defaultValuesFormSubmit in core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php
Processes the submitted default value.
2 methods override FieldItemList::defaultValuesFormSubmit()
DateTimeFieldItemList::defaultValuesFormSubmit in core/modules/datetime/src/Plugin/Field/FieldType/DateTimeFieldItemList.php
Processes the submitted default value.
EntityReferenceFieldItemList::defaultValuesFormSubmit in core/lib/Drupal/Core/Field/EntityReferenceFieldItemList.php
Processes the submitted default value.

File

core/lib/Drupal/Core/Field/FieldItemList.php, line 319

Class

FieldItemList
Represents an entity field; that is, a list of field item objects.

Namespace

Drupal\Core\Field

Code

public function defaultValuesFormSubmit(array $element, array &$form, FormStateInterface $form_state) {
    // Extract the submitted value, and return it as an array.
    if ($widget = $this->defaultValueWidget($form_state)) {
        $widget->extractFormValues($this, $element, $form_state);
        return $this->getValue();
    }
    return [];
}

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