function FormStateInterface::setValue

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

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

mixed $value: The value to set.

Return value

$this

1 method overrides FormStateInterface::setValue()
FormStateDecoratorBase::setValue in core/lib/Drupal/Core/Form/FormStateDecoratorBase.php
Sets the submitted form value for a specific key.

File

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

Class

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

Namespace

Drupal\Core\Form

Code

public function setValue($key, $value);

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