_wp_get_current_user(): WP_User

Description

Compatibility

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

Return value

WP_User

Current WP_User instance.

Performance profile

How much work a call to _wp_get_current_user() 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

6–17

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 43.

Plugin surface

1 hook

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

Called by

2

2 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

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( determine_current_user )filterline 3786 (+40 into the body)

   Filters the current user.

Uses · 2

• wp_set_current_user()Changes the current user by ID or name.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• get_currentuserinfo()Populate global variables with information about the currently logged in user.
• wp_get_current_user()Retrieves the current user object.

Source code

View on Trac ↗View on GitHub ↗

3746function _wp_get_current_user() {3747	global $current_user;3748 3749	if ( ! empty( $current_user ) ) {3750		if ( $current_user instanceof WP_User ) {3751			return $current_user;3752		}3753 3754		// Upgrade stdClass to WP_User.3755		if ( is_object( $current_user ) && isset( $current_user->ID ) ) {3756			$cur_id       = $current_user->ID;3757			$current_user = null;3758			wp_set_current_user( $cur_id );3759			return $current_user;3760		}3761 3762		// $current_user has a junk value. Force to WP_User with ID 0.3763		$current_user = null;3764		wp_set_current_user( 0 );3765		return $current_user;3766	}3767 3768	if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST ) {3769		wp_set_current_user( 0 );3770		return $current_user;3771	}3772 3773	/**3774	 * Filters the current user.3775	 *3776	 * The default filters use this to determine the current user from the3777	 * request's cookies, if available.3778	 *3779	 * Returning a value of false will effectively short-circuit setting3780	 * the current user.3781	 *3782	 * @since 3.9.03783	 *3784	 * @param int|false $user_id User ID if one has been determined, false otherwise.3785	 */3786	$user_id = apply_filters( 'determine_current_user', false );3787	if ( ! $user_id ) {3788		wp_set_current_user( 0 );3789		return $current_user;3790	}3791 3792	wp_set_current_user( $user_id );3793 3794	return $current_user;3795}

Changelog

Introduced in 4.5.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 6.9.7 tag, from src/wp-includes/user.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.