_prime_post_caches( int[] $ids, bool $update_term_cache = true, bool $update_meta_cache = true )
- Since
- 3.4.0, 6.1.0
- Source
wp-includes/post.php:8494
Compatibility
- WordPress
- since 6.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
$idsint[]- ID list.
$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 _prime_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
- Constant
- Instructions
- 14–50
- Plugin surface
- None
- Called by
- 13
Reaches the database via ->get_results().
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 50.
Nothing here hands control to plugin code.
13 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- sqldatabase query
->get_results()called directly - cacheobject cache
wp_cache_get_multiple()one call below _prime_post_caches() - querycontent query
wp_get_object_terms()one call below _prime_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 · 12 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _prime_post_caches() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($non_cached_ids) | 14 | _get_non_cached_ids() |
empty($non_cached_ids) | 17 | _get_non_cached_ids(), update_postmeta_cache() |
empty($non_cached_ids) | 27 | _get_non_cached_ids(), array_map(), array_unique(), update_object_term_cache() |
empty($non_cached_ids) | 30 | _get_non_cached_ids(), update_postmeta_cache(), array_map(), array_unique(), update_object_term_cache() |
!empty($non_cached_ids) | 31 | _get_non_cached_ids(), sprintf(), ->get_results() |
!empty($non_cached_ids) | 34 | _get_non_cached_ids(), sprintf(), ->get_results(), update_postmeta_cache() |
!empty($non_cached_ids) | 34 | _get_non_cached_ids(), sprintf(), ->get_results(), update_post_cache() |
!empty($non_cached_ids) | 37 | _get_non_cached_ids(), sprintf(), ->get_results(), update_post_cache(), update_postmeta_cache() |
!empty($non_cached_ids) | 44 | _get_non_cached_ids(), sprintf(), ->get_results(), array_map(), array_unique(), update_object_term_cache() |
!empty($non_cached_ids) | 47 | _get_non_cached_ids(), sprintf(), ->get_results(), update_postmeta_cache(), array_map(), array_unique(), update_object_term_cache() |
!empty($non_cached_ids) | 47 | _get_non_cached_ids(), sprintf(), ->get_results(), update_post_cache(), array_map(), array_unique(), update_object_term_cache() |
!empty($non_cached_ids) | 50 | _get_non_cached_ids(), sprintf(), ->get_results(), update_post_cache(), update_postmeta_cache(), array_map(), array_unique(), update_object_term_cache() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 50 | 14–50 | 4 | |
| 8.5 | 50 | 14–50 | 4 | |
| 8.4 | 50 | 14–50 | 4 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 53 | 14–53 | 4 | |
| 8.2 | 53 | 14–53 | 4 | |
| 8.1 | 53 | 14–53 | 4 | |
| 7.4 | 53 | 14–53 | 4 |
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 · 4
- _get_non_cached_ids()Retrieves IDs that are not already present in the cache.
- update_post_cache()Updates posts in cache.
- update_postmeta_cache()Updates metadata cache for a list of post IDs.
- update_object_term_cache()Updates the cache for the given term object ID(s).
Used by · 13
- WP_Comment_Query::get_comments()Get a list of comments matching the query vars.
- WP_Navigation_Block_Renderer::get_inner_blocks()Gets the inner blocks for the navigation block.
- WP_Posts_List_Table::_display_rows_hierarchical()
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
- WP_Query::the_post()Sets up the current post.
- WP_Widget_Media_Gallery::has_content()Whether the widget has content to show.
- WP_Widget_Recent_Comments::widget()Outputs the content for the current Recent Comments widget instance.
- block_core_gallery_render()Renders the `core/gallery` block on the server.
- render_block_core_latest_comments()Renders the `core/latest-comments` block on server.
- update_menu_item_cache()Updates post and term caches for all linked objects for a list of menu items.
- update_post_parent_caches()Updates parent post caches for a list of post objects.
- update_post_thumbnail_cache()Updates cache for thumbnails in the current loop.
Show all 13
- wp_filter_content_tags()Filters specific tags in post content and modifies their markup.
Source code
function _prime_post_caches( $ids, $update_term_cache = true, $update_meta_cache = true ) { global $wpdb; $non_cached_ids = _get_non_cached_ids( $ids, 'posts' ); if ( ! empty( $non_cached_ids ) ) { $fresh_posts = $wpdb->get_results( sprintf( "SELECT $wpdb->posts.* FROM $wpdb->posts WHERE ID IN (%s)", implode( ',', $non_cached_ids ) ) ); if ( $fresh_posts ) { // Despite the name, update_post_cache() expects an array rather than a single post. update_post_cache( $fresh_posts ); } } if ( $update_meta_cache ) { update_postmeta_cache( $ids ); } if ( $update_term_cache ) { $post_types = array_map( 'get_post_type', $ids ); $post_types = array_unique( $post_types ); update_object_term_cache( $ids, $post_types ); }}Changelog
Introduced in 3.4.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.1.0 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.