class Token in Drupal 10

Same name in this branch

10 core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token
10 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token

Same name and namespace in other branches

8 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token
9 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\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

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\Core\Render\Element\Hidden
    class \Drupal\Core\Render\Element\Token

Expanded class hierarchy of Token

1 file declares its use of Token

TokenTest.php in core/tests/Drupal/Tests/Core/Render/Element/TokenTest.php

1 string reference to 'Token'

drupal6.php in core/modules/migrate_drupal/tests/fixtures/drupal6.php: A database agnostic dump for testing purposes.

1 #type use of Token

FormBuilder::prepareForm in core/lib/Drupal/Core/Form/FormBuilder.php

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 = static::class;
    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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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.
MessengerTrait::$messenger	protected	property	The messenger.	16
MessengerTrait::messenger	public	function	Gets the messenger.	16
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function
PluginBase::getDerivativeId	public	function
PluginBase::getPluginDefinition	public	function		1
PluginBase::getPluginId	public	function
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	44
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
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
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

You are here