public function FormStateDecoratorBase::unsetValue in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Form/FormStateDecoratorBase.php \Drupal\Core\Form\FormStateDecoratorBase::unsetValue()
2. 10 core/lib/Drupal/Core/Form/FormStateDecoratorBase.php \Drupal\Core\Form\FormStateDecoratorBase::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 = array('foo', 'bar') it will use unset($values['foo']['bar']).

Return value

$this

Overrides FormStateInterface::unsetValue

File

core/lib/Drupal/Core/Form/FormStateDecoratorBase.php, line 544

Class

FormStateDecoratorBase

Decorates another form state.

Namespace

Drupal\Core\Form

Code

public function unsetValue($key) {
  $this->decoratedFormState
    ->unsetValue($key);
  return $this;
}