wp_logout()

Logs the current user out.

Source

function wp_logout() {
	$user_id = get_current_user_id();

	wp_destroy_current_session();
	wp_clear_auth_cookie();
	wp_set_current_user( 0 );

	/**
	 * Fires after a user is logged out.
	 *
	 * @since 1.5.0
	 * @since 5.5.0 Added the `$user_id` parameter.
	 *
	 * @param int $user_id ID of the user that was logged out.
	 */
	do_action( 'wp_logout', $user_id );
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘wp_logout’, int $user_id ): Fires after a user is logged out.

Uses	Description
wp_destroy_current_session()`wp-includes/user.php`	Removes the current session token from the database.
wp_clear_auth_cookie()`wp-includes/pluggable.php`	Removes all of the cookies associated with authentication.
wp_set_current_user()`wp-includes/pluggable.php`	Changes the current user by ID or name.
do_action()`wp-includes/plugin.php`	Calls the callback functions that have been added to an action hook.
get_current_user_id()`wp-includes/user.php`	Gets the current user’s ID.

Show 2 more Show less

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

Skip to note 3 content

Ahir Hemant 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -4You must log in to vote on the helpfulness of this note
Logout function according user role.
```
   function wpdocs_redirect_after_logout() {

        $current_user   = wp_get_current_user();
        $role_name      = $current_user->roles[0];

        if ( 'subscriber' === $role_name ) {
            $redirect_url = site_url();
            wp_safe_redirect( $redirect_url );
            exit;
        } 

    }
    add_action( 'wp_logout', 'wpdocs_redirect_after_logout' );
```
- The WP_User object would have been destroyed at this point in the logout life-cycle. Therefore a redirect based on user-role is not feasible. object(WP_User)[947] public 'data' => object(stdClass)[948] public 'ID' => int 0 public 'caps' => array (size=0) empty public 'cap_key' => null public 'roles' => array (size=0) empty public 'allcaps' => array (size=0) empty public 'filter' => null private 'site_id' => int 0
  
  terungwa 4 years ago
- wp_get_current_user function does not return the logged out user
  
  nimam2 4 years ago
Log in to add feedback
Skip to note 4 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -10You must log in to vote on the helpfulness of this note
Example
```
<?php wp_logout(); ?>
```
- Warning: This function logs the user out as soon as it is called. Don’t add it to button values or widgets using a plugin to insert PHP. If you do so, you might lose access to your admin because you will be logged out every time you visit a page. If you want to create a Logout button, or a link the user can click to log out, use wp_logout_url() instead.
  
  Carike 6 years ago
- Please do not copy / paste this code into a button if you are a new user. wp_logout(); should always be wrapped in an if statement.
  
  Carike 6 years ago
Log in to add feedback

In this article

Source

Hooks

Related

Changelog

User Contributed Notes