public function FormState::getValue in Zircon Profile 8.0

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Form/FormState.php \Drupal\Core\Form\FormState::getValue()

Returns the submitted form value for a specific key.

Parameters

string|array $key: Values are stored as a multi-dimensional associative array. If $key is a string, it will return $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 return $values['foo']['bar'].

mixed $default: (optional) The default value if the specified key does not exist.

Return value

mixed The value for the given key, or NULL.

Overrides FormStateInterface::getValue

File

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

Contains \Drupal\Core\Form\FormState.

Class

FormState

Stores information about the state of a form.

Namespace

Drupal\Core\Form

Code

public function &getValue($key, $default = NULL) {
  $exists = NULL;
  $value =& NestedArray::getValue($this
    ->getValues(), (array) $key, $exists);
  if (!$exists) {
    $value = $default;
  }
  return $value;
}