WP_Session_Tokens::get_instance() │ public static │ WP 4.0.0

Retrieves a session manager instance for a user.

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

Method of the class: WP_Session_Tokens{}

Return

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

Usage

$result = WP_Session_Tokens::get_instance( $user_id );

$user_id(int) (required)

User whose session to manage.

Changelog

WP_Session_Tokens::get_instance() WP Session Tokens::get instance code ^{WP 6.5.2}

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