function Drupal::csrfToken

Same name in other branches
  1. 8.9.x core/lib/Drupal.php \Drupal::csrfToken()
  2. 10 core/lib/Drupal.php \Drupal::csrfToken()
  3. 11.x core/lib/Drupal.php \Drupal::csrfToken()

Returns the CSRF token manager service.

The generated token is based on the session ID of the current user. Normally, anonymous users do not have a session, so the generated token will be different on every page request. To generate a token for users without a session, manually start a session prior to calling this function.

Return value

\Drupal\Core\Access\CsrfTokenGenerator The CSRF token manager.

See also

\Drupal\Core\Session\SessionManager::start()

1 call to Drupal::csrfToken()
DrupalTest::testCsrfToken in core/tests/Drupal/Tests/Core/DrupalTest.php
Tests the csrfToken() method.

File

core/lib/Drupal.php, line 629

Class

Drupal
Static Service Container wrapper.

Code

public static function csrfToken() {
    return static::getContainer()->get('csrf_token');
}

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