WP_Session_Tokens::get_instance( int $user_id ): WP_Session_Tokens

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$user_idint

User whose session to manage.

Return value

WP_Session_Tokens

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

Performance profile

How much work a call to WP_Session_Tokens::get_instance() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11

Executed per call on PHP 8.5. The body compiles to 11.

Plugin surface

1 hook

Third-party callbacks on 'session_token_manager' run inside this call, and their cost is not bounded by anything here.

Called by

8

8 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Session_Tokens::get_instance() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while WP_Session_Tokens::get_instance() runs, in this order:

1. 1
   apply_filters( session_token_manager )filterline 58 (+9 into the body)

   Filters the class name for the session token manager.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 8

• wp_ajax_destroy_sessions()Handles destroying multiple open sessions for a user via AJAX.
• wp_destroy_all_sessions()Removes all session tokens for the current user from the database.
• wp_destroy_current_session()Removes the current session token from the database.
• wp_destroy_other_sessions()Removes all but the current session token for the current user for the database.
• wp_generate_auth_cookie()Generates authentication cookie contents.
• wp_get_all_sessions()Retrieves a list of sessions for the current user.
• wp_set_auth_cookie()Sets the authentication cookies for a given user ID.
• wp_validate_auth_cookie()Validates authentication cookie.

Source code

View on Trac ↗View on GitHub ↗

49	final public static function get_instance( $user_id ) {50		/**51		 * Filters the class name for the session token manager.52		 *53		 * @since 4.0.054		 *55		 * @param string $session Name of class to use as the manager.56		 *                        Default 'WP_User_Meta_Session_Tokens'.57		 */58		$manager = apply_filters( 'session_token_manager', 'WP_User_Meta_Session_Tokens' );59		return new $manager( $user_id );60	}

Changelog

Introduced in 4.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-session-tokens.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.