function FormStateInterface::get

Same name in other branches
  1. 9 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::get()
  2. 8.9.x core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::get()
  3. 10 core/lib/Drupal/Core/Form/FormStateInterface.php \Drupal\Core\Form\FormStateInterface::get()

Gets the value for a property in the form state storage.

Parameters

string|array $property: Properties are often stored as multi-dimensional associative arrays. If $property is a string, it will return $storage[$property]. If $property is an array, each element of the array will be used as a nested key. If $property = ['foo', 'bar'] it will return $storage['foo']['bar'].

Return value

mixed A reference to the value for that property, or NULL if the property does not exist.

See also

\Drupal\Core\Form\FormStateInterface::set()

\Drupal\Core\Form\FormStateInterface::has()

\Drupal\Core\Form\FormStateInterface::getStorage()

\Drupal\Core\Form\FormStateInterface::setStorage()

2 methods override FormStateInterface::get()
FormState::get in core/lib/Drupal/Core/Form/FormState.php
Gets the value for a property in the form state storage.
FormStateDecoratorBase::get in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php
Gets the value for a property in the form state storage.

File

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

Class

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

Namespace

Drupal\Core\Form

Code

public function &get($property);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.