WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Session_Tokens::get_instance()

WP_Session_Tokens::get_instance( int $user_id ): WP_Session_Tokens

In this article

Back to top

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘session_token_manager’, string $session )

Filters the class name for the session token manager.

UsesDescription
apply_filters()wp-includes/plugin.php

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

Used byDescription
wp_ajax_destroy_sessions()wp-admin/includes/ajax-actions.php

Handles destroying multiple open sessions for a user via AJAX.

wp_destroy_all_sessions()wp-includes/user.php

Removes all session tokens for the current user from the database.

wp_get_all_sessions()wp-includes/user.php

Retrieves a list of sessions for the current user.

wp_destroy_current_session()wp-includes/user.php

Removes the current session token from the database.

wp_destroy_other_sessions()wp-includes/user.php

Removes all but the current session token for the current user for the database.

wp_set_auth_cookie()wp-includes/pluggable.php

Sets the authentication cookies based on user ID.

wp_validate_auth_cookie()wp-includes/pluggable.php

Validates authentication cookie.

wp_generate_auth_cookie()wp-includes/pluggable.php

Generates authentication cookie contents.

Show 3 moreShow less

Changelog

VersionDescription
4.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.