function UserController::logout

Same name and namespace in other branches
  1. 11.x core/modules/user/src/Controller/UserController.php \Drupal\user\Controller\UserController::logout()
  2. 10 core/modules/user/src/Controller/UserController.php \Drupal\user\Controller\UserController::logout()
  3. 9 core/modules/user/src/Controller/UserController.php \Drupal\user\Controller\UserController::logout()
  4. 8.9.x core/modules/user/src/Controller/UserController.php \Drupal\user\Controller\UserController::logout()

Logs the current user out.

Attributes

#[Route(path: '/user/logout', name: 'user.logout', requirements: [ '_user_is_logged_in' => 'TRUE', '_csrf_token' => 'TRUE', ], options: [ '_csrf_confirm_form_route' => 'user.logout.confirm', ])]

Return value

\Symfony\Component\HttpFoundation\RedirectResponse A redirection to home page.

File

core/modules/user/src/Controller/UserController.php, line 447

Class

UserController
Controller routines for user routes.

Namespace

Drupal\user\Controller

Code

public function logout() {
  if ($this->currentUser()
    ->isAuthenticated()) {
    user_logout();
  }
  return $this->redirect('<front>');
}

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