update_post_caches( WP_Post[] $posts, string|string[] $post_type = 'post', bool $update_term_cache = true, bool $update_meta_cache = true )

Compatibility

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_typestring|string[]optional

Single post type, 'any', or an array of post types.
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

Reaches the database via wp_get_object_terms().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

6–39

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• cacheobject cachewp_cache_add_multiple()one call below update_post_caches()
• querycontent querywp_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.

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

View on Trac ↗View on GitHub ↗

7998function update_post_caches( &$posts, $post_type = 'post', $update_term_cache = true, $update_meta_cache = true ) {7999	// No point in doing all this work if we didn't match any posts.8000	if ( ! $posts ) {8001		return;8002	}8003 8004	update_post_cache( $posts );8005 8006	$post_ids = array();8007	foreach ( $posts as $post ) {8008		$post_ids[] = $post->ID;8009	}8010 8011	if ( ! $post_type ) {8012		$post_type = 'any';8013	}8014 8015	if ( $update_term_cache ) {8016		if ( is_array( $post_type ) ) {8017			$ptypes = $post_type;8018		} elseif ( 'any' === $post_type ) {8019			$ptypes = array();8020			// Just use the post_types in the supplied posts.8021			foreach ( $posts as $post ) {8022				$ptypes[] = $post->post_type;8023			}8024			$ptypes = array_unique( $ptypes );8025		} else {8026			$ptypes = array( $post_type );8027		}8028 8029		if ( ! empty( $ptypes ) ) {8030			update_object_term_cache( $post_ids, $ptypes );8031		}8032	}8033 8034	if ( $update_meta_cache ) {8035		update_postmeta_cache( $post_ids );8036	}8037}

Changelog

Introduced in 1.5.0. One change between 6.7.7 and 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.

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.