W3cubDocs

/WordPress

WP_Session_Tokens::get_instance( int $user_id ): WP_Session_Tokens

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_idintrequired
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

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 );
}

Hooks

apply_filters( ‘session_token_manager’, string $session )

Filters the class name for the session token manager.

Changelog

Version Description
4.0.0 Introduced.

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