update_post_caches( WP_Post[] $posts, string $post_type = 'post', bool $update_term_cache = true, bool $update_meta_cache = true )
- Since
- 1.5.0
- Source
wp-includes/post.php:7688
Compatibility
- WordPress
- since 1.5.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
$postsWP_Post[]- Array of post objects (passed by reference).
$post_typestringoptional- Post type. Default 'post'.Default:
'post' $update_term_cachebooloptional- Whether to update the term cache. Default true.Default:
true $update_meta_cachebooloptional- Whether to update the meta cache. Default true.Default:
true
Performance profile
How much work a call to update_post_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
- Heavy
- Scaling
- Scales with input
- Instructions
- 6–39
- Plugin surface
- None
- Called by
- 1
Reaches the database via wp_get_object_terms().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 51.
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
- cacheobject cache
wp_cache_add_multiple()one call below update_post_caches() - querycontent query
wp_get_object_terms()one call below update_post_caches()
Further down the call graph this can also reach hook, option, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 9 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost update_post_caches() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | none |
| always | 15–24 | update_post_cache() |
| always | 18–27 | update_post_cache(), update_postmeta_cache() |
!empty($ptypes) | 25–28 | update_post_cache(), update_object_term_cache() |
!empty($ptypes) | 28–31 | update_post_cache(), update_object_term_cache(), update_postmeta_cache() |
!is_array($post_type) && $post_type === "any" && empty($ptypes) | 29–32 | update_post_cache(), array_unique() |
!is_array($post_type) && $post_type === "any" && empty($ptypes) | 32–35 | update_post_cache(), array_unique(), update_postmeta_cache() |
!is_array($post_type) && $post_type === "any" && !empty($ptypes) | 33–36 | update_post_cache(), array_unique(), update_object_term_cache() |
!is_array($post_type) && $post_type === "any" && !empty($ptypes) | 36–39 | update_post_cache(), array_unique(), update_object_term_cache(), update_postmeta_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: 51 instructions, 6–39 executed per call, 11 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 · 3
- update_post_cache()Updates posts in cache.
- update_object_term_cache()Updates the cache for the given term object ID(s).
- update_postmeta_cache()Updates metadata cache for a list of post IDs.
Used by · 1
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
Source code
function update_post_caches( &$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true ) { // No point in doing all this work if we didn't match any posts. if ( ! $posts ) { return; } update_post_cache( $posts ); $post_ids = array(); foreach ( $posts as $post ) { $post_ids[] = $post->ID; } if ( ! $post_type ) { $post_type = 'any'; } if ( $update_term_cache ) { if ( is_array( $post_type ) ) { $ptypes = $post_type; } elseif ( 'any' === $post_type ) { $ptypes = array(); // Just use the post_types in the supplied posts. foreach ( $posts as $post ) { $ptypes[] = $post->post_type; } $ptypes = array_unique( $ptypes ); } else { $ptypes = array( $post_type ); } if ( ! empty( $ptypes ) ) { update_object_term_cache( $post_ids, $ptypes ); } } if ( $update_meta_cache ) { update_postmeta_cache( $post_ids ); }}Changelog
Introduced in 1.5.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post_type retyped from string to string|string[].verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/post.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.