public function FormState::unsetValue in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Core/Form/FormState.php \Drupal\Core\Form\FormState::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

1 call to FormState::unsetValue()

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

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

File

core/lib/Drupal/Core/Form/FormState.php, line 1017

Contains \Drupal\Core\Form\FormState.

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;
}