clean_object_term_cache( int|array $object_ids, array|string $object_type )
- Since
- 2.3.0
- Source
wp-includes/taxonomy.php:3673
Description
Will remove the entire taxonomy relationship containing term $object_id. The term IDs have to exist within the taxonomy $object_type for the deletion to take place.
Compatibility
- WordPress
- since 2.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
$object_idsint|array- Single or list of term object ID(s).
$object_typearray|string- The taxonomy object type.
Performance profile
How much work a call to clean_object_term_cache() 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
- Moderate
- Scaling
- Scales with input
- Instructions
- 6–24
- Plugin surface
- 1 hook
- Called by
- 4
Only touches the object cache, via wp_cache_delete_multiple().
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 31.
Third-party callbacks on 'clean_object_term_cache' run inside this call, and their cost is not bounded by anything here.
4 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- cacheobject cache
wp_cache_delete_multiple()called directly - hookthird-party callbacks
do_action()called directly
Further down the call graph this can also reach query, serialize, option 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost clean_object_term_cache() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($_wp_suspend_cache_invalidation) | 6 | none |
empty($_wp_suspend_cache_invalidation) | 21–24 | get_object_taxonomies(), wp_cache_set_terms_last_changed(), do_action() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 31 instructions, 6–24 executed per call, 4 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.
Hooks and filters fired · 1
One hook fires while clean_object_term_cache() runs, in this order:
- do_action( clean_object_term_cache )actionline 3700 (+27 into the body)
Fires after the object term cache has been cleaned.
Uses · 4
- get_object_taxonomies()Returns the names or objects of the taxonomies which are registered for the requested object or object type, such as a post object or post type name.
- wp_cache_delete_multiple()Deletes multiple values from the cache in one call.
- wp_cache_set_terms_last_changed()Sets the last changed time for the 'terms' cache group.
- do_action()Calls the callback functions that have been added to an action hook.
Used by · 4
- clean_attachment_cache()Will clean the attachment in the cache.
- clean_bookmark_cache()Deletes the bookmark cache.
- clean_post_cache()Will clean the post in the cache.
- wp_delete_term()Removes a term from the database.
Source code
function clean_object_term_cache( $object_ids, $object_type ) { global $_wp_suspend_cache_invalidation; if ( ! empty( $_wp_suspend_cache_invalidation ) ) { return; } if ( ! is_array( $object_ids ) ) { $object_ids = array( $object_ids ); } $taxonomies = get_object_taxonomies( $object_type ); foreach ( $taxonomies as $taxonomy ) { wp_cache_delete_multiple( $object_ids, "{$taxonomy}_relationships" ); } wp_cache_set_terms_last_changed(); /** * Fires after the object term cache has been cleaned. * * @since 2.5.0 * * @param array $object_ids An array of object IDs. * @param string $object_type Object type. */ do_action( 'clean_object_term_cache', $object_ids, $object_type );}Changelog
Introduced in 2.3.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/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.