W3cubDocs

/Drupal 8

public function FormState::unsetValue

public FormState::unsetValue($key)

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/FormState.php, line 1011

Class

FormState
Stores information about the state of a form.

Namespace

Drupal\Core\Form

Code

public function unsetValue($key) {
  NestedArray::unsetValue($this->getValues(), (array) $key);
  return $this;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Form!FormState.php/function/FormState::unsetValue/8.1.x