function WidgetInterface::massageFormValues
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::massageFormValues()
- 10 core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::massageFormValues()
- 11.x core/lib/Drupal/Core/Field/WidgetInterface.php \Drupal\Core\Field\WidgetInterface::massageFormValues()
Massages the form values into the format expected for field values.
Parameters
array $values: The submitted form values produced by the widget.
- If the widget does not manage multiple values itself, the array holds the values generated by the multiple copies of the $element generated by the formElement() method, keyed by delta.
- If the widget manages multiple values, the array holds the values of the form element generated by the formElement() method.
array $form: The form structure where field elements are attached to. This might be a full form structure, or a sub-element of a larger form.
\Drupal\Core\Form\FormStateInterface $form_state: The form state.
Return value
array An array of field values, keyed by delta.
1 method overrides WidgetInterface::massageFormValues()
- WidgetBase::massageFormValues in core/
lib/ Drupal/ Core/ Field/ WidgetBase.php - Massages the form values into the format expected for field values.
File
-
core/
lib/ Drupal/ Core/ Field/ WidgetInterface.php, line 148
Class
- WidgetInterface
- Interface definition for field widget plugins.
Namespace
Drupal\Core\FieldCode
public function massageFormValues(array $values, array $form, FormStateInterface $form_state);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.