clean_term_cache( int|int[] $ids, string $taxonomy = '', bool $clean_taxonomy = true )
- Since
- 2.3.0
- Source
wp-includes/taxonomy.php:3671
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
$idsint|int[]- Single or array of term IDs.
$taxonomystringoptional- Taxonomy slug. Can be empty, in which case the taxonomies of the passed term IDs will be used. Default empty.Default:
'' $clean_taxonomybooloptional- Whether to clean taxonomy wide caches (true), or just individual term object caches (false). Default true.Default:
true
Performance profile
How much work a call to clean_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
- Heavy
- Scaling
- Scales with input
- Instructions
- 8–51
- Plugin surface
- 1 hook
- Called by
- 6
Reaches the database via ->get_results().
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 76.
Third-party callbacks on 'clean_term_cache' run inside this call, and their cost is not bounded by anything here.
6 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 - sqldatabase query
->get_results()called directly - optionoption read or write
delete_option()one call below clean_term_cache()
Further down the call graph this can also reach query, 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost clean_term_cache() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!empty($_wp_suspend_cache_invalidation) | 8 | none |
empty($_wp_suspend_cache_invalidation) && !empty($taxonomy) | 23–26 | wp_cache_delete_multiple(), wp_cache_set_terms_last_changed() |
empty($_wp_suspend_cache_invalidation) && empty($taxonomy) | 47–51 | array_map(), ->get_results(), wp_cache_delete_multiple(), array_unique(), wp_cache_set_terms_last_changed() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 76 | 8–51 | 8 | |
| 8.5 | 76 | 8–51 | 8 | |
| 8.4 | 76 | 8–51 | 8 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 79 | 8–54 | 8 | |
| 8.2 | 79 | 8–54 | 8 | |
| 8.1 | 79 | 8–54 | 8 | |
| 7.4 | 79 | 8–54 | 8 |
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_term_cache() runs, in this order:
- do_action( clean_term_cache )actionline 3716 (+45 into the body)
Fires once after each taxonomy's term cache has been cleaned.
Uses · 4
- wp_cache_delete_multiple()Deletes multiple values from the cache in one call.
- clean_taxonomy_cache()Cleans the caches for a taxonomy.
- do_action()Calls the callback functions that have been added to an action hook.
- wp_cache_set_terms_last_changed()Sets the last changed time for the 'terms' cache group.
Used by · 6
- _split_shared_term()Creates a new term for a term_taxonomy item that currently shares its term with another term_taxonomy.
- clean_category_cache()Removes the category cache data based on ID.
- wp_delete_term()Removes a term from the database.
- wp_insert_term()Adds a new term to the database.
- wp_update_term()Updates term based on arguments provided.
- wp_update_term_count_now()Performs term count update immediately.
Source code
function clean_term_cache( $ids, $taxonomy = '', $clean_taxonomy = true ) { global $wpdb, $_wp_suspend_cache_invalidation; if ( ! empty( $_wp_suspend_cache_invalidation ) ) { return; } if ( ! is_array( $ids ) ) { $ids = array( $ids ); } $taxonomies = array(); // If no taxonomy, assume tt_ids. if ( empty( $taxonomy ) ) { $tt_ids = array_map( 'intval', $ids ); $tt_ids = implode( ', ', $tt_ids ); $terms = $wpdb->get_results( "SELECT term_id, taxonomy FROM $wpdb->term_taxonomy WHERE term_taxonomy_id IN ($tt_ids)" ); $ids = array(); foreach ( (array) $terms as $term ) { $taxonomies[] = $term->taxonomy; $ids[] = $term->term_id; } wp_cache_delete_multiple( $ids, 'terms' ); $taxonomies = array_unique( $taxonomies ); } else { wp_cache_delete_multiple( $ids, 'terms' ); $taxonomies = array( $taxonomy ); } foreach ( $taxonomies as $taxonomy ) { if ( $clean_taxonomy ) { clean_taxonomy_cache( $taxonomy ); } /** * Fires once after each taxonomy's term cache has been cleaned. * * @since 2.5.0 * @since 4.5.0 Added the `$clean_taxonomy` parameter. * * @param array $ids An array of term IDs. * @param string $taxonomy Taxonomy slug. * @param bool $clean_taxonomy Whether or not to clean taxonomy-wide caches */ do_action( 'clean_term_cache', $ids, $taxonomy, $clean_taxonomy ); } wp_cache_set_terms_last_changed();}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 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.