You are here

public static function Token::valueCallback in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token::valueCallback()
  2. 9 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token::valueCallback()

Determines how user input is mapped to an element's #value property.

Parameters

array $element: An associative array containing the properties of the element.

mixed $input: The incoming input to populate the form element. If this is FALSE, the element's default value should be returned.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

mixed The value to assign to the element.

Overrides FormElement::valueCallback

1 call to Token::valueCallback()
TokenTest::testValueCallback in core/tests/Drupal/Tests/Core/Render/Element/TokenTest.php
@covers ::valueCallback

File

core/lib/Drupal/Core/Render/Element/Token.php, line 36

Class

Token
Stores token data in a hidden form field.

Namespace

Drupal\Core\Render\Element

Code

public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
  if ($input !== FALSE && $input !== NULL) {

    // This should be a string, but allow other scalars since they might be
    // valid input in programmatic form submissions.
    return is_scalar($input) ? (string) $input : '';
  }
  return NULL;
}