update_user_caches( object|WP_User $user ): void|false
- Since
- 3.0.0
- Source
wp-includes/user.php:1992
Compatibility
- WordPress
- since 3.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$userobject|WP_User- User object or database row to be cached
Return value
void|false- Void on success, false on failure.
Performance profile
How much work a call to update_user_caches() 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
- Light
- Scaling
- Constant
- Instructions
- 7–45
- Plugin surface
- None
- Called by
- 2
Only touches the object cache, via wp_cache_add().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 46.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- cacheobject cache
wp_cache_add()called directly
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost update_user_caches() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$user instanceof && !->exists() | 7 | ->exists() |
!($user instanceof) && empty($user) | 31 | wp_cache_add(), wp_cache_add(), wp_cache_add() |
$user instanceof && ->exists() && empty($user) | 36 | ->exists(), wp_cache_add(), wp_cache_add(), wp_cache_add() |
!($user instanceof) && !empty($user) | 40 | wp_cache_add(), wp_cache_add(), wp_cache_add(), wp_cache_add() |
$user instanceof && ->exists() && !empty($user) | 45 | ->exists(), wp_cache_add(), wp_cache_add(), wp_cache_add(), wp_cache_add() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 46 instructions, 7–45 executed per call, 3 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- wp_cache_add()Adds data to the cache, if the cache key doesn't already exist.
Used by · 2
- WP_User::get_data_by()Returns only the main user fields.
- cache_users()Retrieves info for user lists to prevent multiple queries by get_userdata().
Source code
function update_user_caches( $user ) { if ( $user instanceof WP_User ) { if ( ! $user->exists() ) { return false; } $user = $user->data; } wp_cache_add( $user->ID, $user, 'users' ); wp_cache_add( $user->user_login, $user->ID, 'userlogins' ); wp_cache_add( $user->user_nicename, $user->ID, 'userslugs' ); if ( ! empty( $user->user_email ) ) { wp_cache_add( $user->user_email, $user->ID, 'useremail' ); }}Changelog
Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 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.