class Token
Same name in this branch
- 11.x core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token
Same name in other branches
- 9 core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token
- 9 core/lib/Drupal/Core/Utility/Token.php \Drupal\Core\Utility\Token
- 8.9.x core/lib/Drupal/Core/Render/Element/Token.php \Drupal\Core\Render\Element\Token
- 8.9.x 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
- 10 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.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Token
1 file declares its use of Token
- TokenTest.php in core/
tests/ Drupal/ Tests/ Core/ Render/ Element/ TokenTest.php
22 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.
- drupal6.php in core/
modules/ book/ tests/ fixtures/ drupal6.php - A database agnostic dump for testing purposes.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Token.php, line 16
Namespace
Drupal\Core\Render\ElementView 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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | |
FormElementBase::processPattern | public static | function | #process callback for #pattern form element property. | 1 | |
FormElementBase::validatePattern | public static | function | #element_validate callback for #pattern form element property. | 1 | |
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. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 | |
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | |
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | |
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | |
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | |
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 |
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 FormElementBase::valueCallback |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.