WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

update_sitemeta_cache()

update_sitemeta_cache( array $site_ids ): array|false

In this article

Back to top

Updates metadata cache for list of site IDs.

Description

Performs SQL query to retrieve all metadata for the sites matching $site_ids and stores them in the cache.
Subsequent calls to get_site_meta() will not need to query the database.

Parameters

$site_idsarrayrequired
List of site IDs.

Return

array|false An array of metadata on success, false if there is nothing to update.

Source

function update_sitemeta_cache( $site_ids ) {
	// Ensure this filter is hooked in even if the function is called early.
	if ( ! has_filter( 'update_blog_metadata_cache', 'wp_check_site_meta_support_prefilter' ) ) {
		add_filter( 'update_blog_metadata_cache', 'wp_check_site_meta_support_prefilter' );
	}
	return update_meta_cache( 'blog', $site_ids );
}

View all references View on Trac View on GitHub

UsesDescription
has_filter()wp-includes/plugin.php

Checks if any filter has been registered for a hook.

update_meta_cache()wp-includes/meta.php

Updates the metadata cache for the specified objects.

add_filter()wp-includes/plugin.php

Adds a callback function to a filter hook.

Show 1 moreShow less
Used byDescription
update_site_cache()wp-includes/ms-site.php

Updates sites in cache.

Changelog

VersionDescription
5.1.0Introduced.

User Contributed Notes

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