wppaste
WordPress

_prime_term_caches( array $term_ids, bool $update_meta_cache = true )

Since
4.6.0, 6.1.0, 6.3.0
Source
wp-includes/taxonomy.php:4114
Adds any terms from the given IDs to the cache that do not already exist in cache.

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

$term_idsarray
Array of term IDs.
$update_meta_cachebooloptional
Whether to update the meta cache. Default true.Default: true

Performance profile

How much work a call to _prime_term_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

Reaches the database via ->get_results().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
12–38

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 38.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
3

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 cachewp_cache_get_multiple()one call below _prime_term_caches()

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_term_caches() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
empty($non_cached_ids)12_get_non_cached_ids()
empty($non_cached_ids)15_get_non_cached_ids(), wp_lazyload_term_meta()
!empty($non_cached_ids)35_get_non_cached_ids(), array_map(), sprintf(), ->get_results(), update_term_cache()
!empty($non_cached_ids)38_get_non_cached_ids(), array_map(), sprintf(), ->get_results(), update_term_cache(), wp_lazyload_term_meta()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev3812–382
8.53812–382
8.43812–3823 fewer instructions than PHP 8.3
8.34112–412
8.24112–412
8.14112–412
7.44112–412

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

Used by · 3

Source code

function _prime_term_caches( $term_ids, $update_meta_cache = true ) {	global $wpdb; 	$non_cached_ids = _get_non_cached_ids( $term_ids, 'terms' );	if ( ! empty( $non_cached_ids ) ) {		$fresh_terms = $wpdb->get_results( sprintf( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id IN (%s)", implode( ',', array_map( 'intval', $non_cached_ids ) ) ) ); 		update_term_cache( $fresh_terms );	} 	if ( $update_meta_cache ) {		wp_lazyload_term_meta( $term_ids );	}}

Changelog

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

6.3.0
Use wp_lazyload_term_meta() for lazy-loading of term meta.from the docblock
6.1.0
This function is no longer marked as "private".from the docblock
4.6.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/taxonomy.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.