FormState::addCleanValueKey

public FormState::addCleanValueKey($cleanValueKey)

Adds a key to the array of form values that will be cleaned.

Parameters

string $key: The form value key to be cleaned.

Return value

$this

Overrides FormStateInterface::addCleanValueKey

File

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

Class

FormState: Stores information about the state of a form.

Namespace

Drupal\Core\Form

Code

public function addCleanValueKey($cleanValueKey) {
  $keys = $this->getCleanValueKeys();
  $this->setCleanValueKeys(array_merge((array) $keys, [$cleanValueKey]));
  return $this;
}

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21FormState.php/function/FormState%3A%3AaddCleanValueKey/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Popular Articles

FormStateDecoratorBase::addCleanValueKey public FormStateDecoratorBase::addCleanValueKey($cleanValueKey) Adds a key to the array of form values that will be cleaned. Parameters string $key:

FormStateInterface::addCleanValueKey public FormStateInterface::addCleanValueKey($key) Adds a key to the array of form values that will be cleaned. Parameters string $key: The form valu

FormState Stores information about the state of a form. Hierarchy class \Drupal\Core\Form\FormState implements FormStateInterface uses FormStateValuesTrait

FormState::isValidationEnforced public FormState::isValidationEnforced() Checks if validation is enforced. Return value bool If TRUE, validation will always be run. Overrides FormS

FormState::addBuildInfo public FormState::addBuildInfo($property, $value) Adds a value to the build info. Parameters string $property: The property to use for the value. mi