public function FormStateInterface::getValue in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::getValue()
2. 9 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::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.

1 method overrides FormStateInterface::getValue()

FormStateDecoratorBase::getValue in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php

Returns the submitted form value for a specific key.

File

core/lib/Drupal/Core/Form/FormStateInterface.php, line 300

Class

FormStateInterface

Provides an interface for an object containing the current state of a form.

Namespace

Drupal\Core\Form

Code

public function &getValue($key, $default = NULL);