update_sitemeta_cache( array $site_ids ): array|false
- Since
- 5.1.0
- Source
wp-includes/ms-site.php:424
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.
Compatibility
- WordPress
- since 5.1.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
$site_idsarray- List of site IDs.
Return value
array|false- An array of metadata on success, false if there is nothing to update.
Performance profile
How much work a call to update_sitemeta_cache() 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
- 11–15
- Plugin surface
- None
- Called by
- 1
Only touches the object cache, via wp_cache_get_multiple().
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 15.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below update_sitemeta_cache() - cacheobject cache
wp_cache_get_multiple()one call below update_sitemeta_cache()
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost update_sitemeta_cache() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
has_filter() | 11 | has_filter(), update_meta_cache() |
!has_filter() | 15 | has_filter(), add_filter(), update_meta_cache() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 15 instructions, 11–15 executed per call, 1 branch. 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 · 3
- has_filter()Checks if any filter has been registered for a hook.
- add_filter()Adds a callback function to a filter hook.
- update_meta_cache()Updates the metadata cache for the specified objects.
Used by · 1
- update_site_cache()Updates sites in cache.
Source code
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 );}Changelog
Introduced in 5.1.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 6.8.8 tag, from
src/wp-includes/ms-site.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.