public function FormStateInterface::cleanValues in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::cleanValues()

Removes internal Form API elements and buttons from submitted form values.

This function can be used when a module wants to store all submitted form values, for example, by serializing them into a single database column. In such cases, all internal Form API values and all form button elements should not be contained, and this function allows their removal before the module proceeds to storage. Next to button elements, the following internal values are removed by default.

• form_id
• form_token
• form_build_id
• op

Return value

$this

2 methods override FormStateInterface::cleanValues()

FormState::cleanValues in core/lib/Drupal/Core/Form/FormState.php

Removes internal Form API elements and buttons from submitted form values.

FormStateDecoratorBase::cleanValues in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php

Removes internal Form API elements and buttons from submitted form values.

File

core/lib/Drupal/Core/Form/FormStateInterface.php, line 1111

Class

FormStateInterface

Provides an interface for an object containing the current state of a form.

Namespace

Drupal\Core\Form

Code

public function cleanValues();