class 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 \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\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
      • class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\FormElementInterface
        • class \Drupal\Core\Render\Element\Hidden extends \Drupal\Core\Render\Element\FormElement
          • class \Drupal\Core\Render\Element\Token extends \Drupal\Core\Render\Element\Hidden

Expanded class hierarchy of Token

File

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

Namespace

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