function FormStateInterface::set

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

Sets 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 use $storage[$property] = $value. If $property is an array, each element of the array will be used as a nested key. If $property = ['foo', 'bar'] it will use $storage['foo']['bar'] = $value.

mixed $value: The value to set.

Return value

$this

See also

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

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

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

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

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

File

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

Class

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

Namespace

Drupal\Core\Form

Code

public function set($property, $value);

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