WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

update_user_caches()

update_user_caches( object|WP_User $user ): void|false

In this article

Back to top

Updates all user caches.

Parameters

$userobject|WP_Userrequired
User object or database row to be cached

Return

void|false Void on success, false on failure.

Source

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

View all references View on Trac View on GitHub

UsesDescription
wp_cache_add()wp-includes/cache.php

Adds data to the cache, if the cache key doesn’t already exist.

Used byDescription
WP_User::get_data_by()wp-includes/class-wp-user.php

Returns only the main user fields.

cache_users()wp-includes/pluggable.php

Retrieves info for user lists to prevent multiple queries by get_userdata() .

Changelog

VersionDescription
3.0.0Introduced.

User Contributed Notes

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