Same name and namespace in other branches
  1. 4.6.x modules/user.module \user_logout()
  2. 4.7.x modules/user.module \user_logout()
  3. 5.x modules/user/user.module \user_logout()
  4. 6.x modules/user/user.pages.inc \user_logout()
  5. 7.x modules/user/user.pages.inc \user_logout()
  6. 8.9.x core/modules/user/user.module \user_logout()
  7. 9 core/modules/user/user.module \user_logout()

Logs the current user out.

1 call to user_logout()
MaintenanceModeSubscriber::onMaintenanceModeRequest in core/modules/user/src/EventSubscriber/MaintenanceModeSubscriber.php
Logout users if site is in maintenance mode and user is not exempt.

File

core/modules/user/user.module, line 1237
Enables the user registration and login system.

Code

function user_logout() {
  $user = \Drupal::currentUser();
  \Drupal::logger('user')
    ->info('Session closed for %name.', [
    '%name' => $user
      ->getAccountName(),
  ]);
  \Drupal::moduleHandler()
    ->invokeAll('user_logout', [
    $user,
  ]);

  // Destroy the current session, and reset $user to the anonymous user.
  // Note: In Symfony the session is intended to be destroyed with
  // Session::invalidate(). Regrettably this method is currently broken and may
  // lead to the creation of spurious session records in the database.
  // @see https://github.com/symfony/symfony/issues/12375
  \Drupal::service('session_manager')
    ->destroy();
  $user
    ->setAccount(new AnonymousUserSession());
}