WP_Session_Tokens::get_instance( int $user_id )

Retrieves a session manager instance for a user.

Description

This method contains a ‘session_token_manager’ filter, allowing a plugin to swap out the session manager for a subclass of WP_Session_Tokens.

Parameters

$user_id

(int) (Required) User whose session to manage.

Return

(WP_Session_Tokens) The session object, which is by default an instance of the WP_User_Meta_Session_Tokens class.

Source

File: wp-includes/class-wp-session-tokens.php 

final public static function get_instance( $user_id ) {
		/**
		 * Filters the class name for the session token manager.
		 *
		 * @since 4.0.0
		 *
		 * @param string $session Name of class to use as the manager.
		 *                        Default 'WP_User_Meta_Session_Tokens'.
		 */
		$manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' );
		return new $manager( $user_id );
	}

Uses

Uses Description
wp-includes/class-wp-session-tokens.php: session_token_manager

Filters the class name for the session token manager.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.

Used By

Used By Description
wp-admin/includes/ajax-actions.php: wp_ajax_destroy_sessions()

Ajax handler for destroying multiple open sessions for a user.
wp-includes/user.php: wp_destroy_all_sessions()

Remove all session tokens for the current user from the database.
wp-includes/user.php: wp_get_all_sessions()

Retrieve a list of sessions for the current user.
wp-includes/user.php: wp_destroy_current_session()

Remove the current session token from the database.
wp-includes/user.php: wp_destroy_other_sessions()

Remove all but the current session token for the current user for the database.
wp-includes/pluggable.php: wp_set_auth_cookie()

Sets the authentication cookies based on user ID.
wp-includes/pluggable.php: wp_validate_auth_cookie()

Validates authentication cookie.
wp-includes/pluggable.php: wp_generate_auth_cookie()

Generates authentication cookie contents.

Changelog

Version Description
4.0.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_session_tokens/get_instance