function FormStateInterface::unsetValue
Same name in other branches
- 9 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::unsetValue()
- 8.9.x core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::unsetValue()
- 10 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::unsetValue()
Removes a specific key from the submitted form values.
Parameters
string|array $key: Values are stored as a multi-dimensional associative array. If $key is a string, it will use unset($values[$key]). If $key is an array, each element of the array will be used as a nested key. If $key = ['foo', 'bar'] it will use unset($values['foo']['bar']).
Return value
$this
1 method overrides FormStateInterface::unsetValue()
- FormStateDecoratorBase::unsetValue in core/
lib/ Drupal/ Core/ Form/ FormStateDecoratorBase.php - Removes a specific key from the submitted form values.
File
-
core/
lib/ Drupal/ Core/ Form/ FormStateInterface.php, line 386
Class
- FormStateInterface
- Provides an interface for an object containing the current state of a form.
Namespace
Drupal\Core\FormCode
public function unsetValue($key);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.