_prime_comment_caches( int[] $comment_ids, bool $update_meta_cache = true )
- Since
- 4.4.0, 6.1.0, 6.3.0
- Source
wp-includes/comment.php:3408
Compatibility
- WordPress
- since 6.3.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
$comment_idsint[]- Array of comment IDs.
$update_meta_cachebooloptional- Whether to update the meta cache. Default true.Default:
true
Performance profile
How much work a call to _prime_comment_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
- 12–39
- Plugin surface
- None
- Called by
- 3
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 39.
Nothing here hands control to plugin code.
3 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_comment_caches()
Further down the call graph this can also reach hook. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _prime_comment_caches() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($non_cached_ids) | 12 | _get_non_cached_ids() |
empty($non_cached_ids) | 15 | _get_non_cached_ids(), wp_lazyload_comment_meta() |
!empty($non_cached_ids) | 36 | _get_non_cached_ids(), array_map(), sprintf(), ->get_results(), update_comment_cache() |
!empty($non_cached_ids) | 39 | _get_non_cached_ids(), array_map(), sprintf(), ->get_results(), update_comment_cache(), wp_lazyload_comment_meta() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 39 | 12–39 | 2 | |
| 8.5 | 39 | 12–39 | 2 | |
| 8.4 | 39 | 12–39 | 2 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 42 | 12–42 | 2 | |
| 8.2 | 42 | 12–42 | 2 | |
| 8.1 | 42 | 12–42 | 2 | |
| 7.4 | 42 | 12–42 | 2 |
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
- _get_non_cached_ids()Retrieves IDs that are not already present in the cache.
- update_comment_cache()Updates the comment cache of given comments.
- wp_lazyload_comment_meta()Queue comment meta for lazy-loading.
Used by · 3
- WP_Comment_Query::fill_descendants()Fetch descendants for located comments.
- WP_Comment_Query::get_comments()Get a list of comments matching the query vars.
- WP_Query::get_posts()Retrieves an array of posts based on query variables.
Source code
function _prime_comment_caches( $comment_ids, $update_meta_cache = true ) { global $wpdb; $non_cached_ids = _get_non_cached_ids( $comment_ids, 'comment' ); if ( ! empty( $non_cached_ids ) ) { $fresh_comments = $wpdb->get_results( sprintf( "SELECT $wpdb->comments.* FROM $wpdb->comments WHERE comment_ID IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); update_comment_cache( $fresh_comments, false ); } if ( $update_meta_cache ) { wp_lazyload_comment_meta( $comment_ids ); }}Changelog
Introduced in 4.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 6.8.8 tag, from
src/wp-includes/comment.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.