class Token

Same name in this branch
  1. 8.9.x core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token
Same name in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token
  2. 9 core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token
  3. 10 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token
  4. 10 core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token
  5. 11.x core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token
  6. 11.x core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token

Stores token data in a hidden form field.

This is generally used to protect against cross-site forgeries. A token element is automatically added to each Drupal form by an implementation of \Drupal\Core\Form\FormBuilderInterface::prepareForm() so you don't generally have to add one yourself.

Plugin annotation

@FormElement("token");

Hierarchy

Expanded class hierarchy of Token

1 file declares its use of Token
TokenTest.php in core/tests/Drupal/Tests/Core/Render/Element/TokenTest.php
14 string references to 'Token'
BatchStorage::schemaDefinition in core/lib/Drupal/Core/Batch/BatchStorage.php
Defines the schema for the batch table.
ContentTranslationHandler::entityFormSharedElements in core/modules/content_translation/src/ContentTranslationHandler.php
Process callback: determines which elements get clue in the form.
ContentTranslationHandlerTest::providerTestEntityFormSharedElements in core/modules/content_translation/tests/src/Kernel/ContentTranslationHandlerTest.php
Returns test cases for ::testEntityFormSharedElements().
CsrfAccessCheck::access in core/lib/Drupal/Core/Access/CsrfAccessCheck.php
Checks access based on a CSRF token for the request.
DrupalTest::testToken in core/tests/Drupal/Tests/Core/DrupalTest.php
Tests the token() method.

... See full list

1 #type use of Token
FormBuilder::prepareForm in core/lib/Drupal/Core/Form/FormBuilder.php
Prepares a structured form array.

File

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

Namespace

Drupal\Core\Render\Element
View source
class Token extends Hidden {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = get_class($this);
        return [
            '#input' => TRUE,
            '#pre_render' => [
                [
                    $class,
                    'preRenderHidden',
                ],
            ],
            '#theme' => 'input__hidden',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    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;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
Hidden::preRenderHidden public static function Prepares a #type 'hidden' render element for input.html.twig.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
Token::getInfo public function Returns the element properties for this element. Overrides Hidden::getInfo
Token::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback

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