clean_taxonomy_cache( string $taxonomy )
- Since
- 4.9.0
- Source
wp-includes/taxonomy.php:3729
Compatibility
- WordPress
- since 4.9.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
$taxonomystring- Taxonomy slug.
Performance profile
How much work a call to clean_taxonomy_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
- Constant
- Instructions
- 20–27
- Plugin surface
- 1 hook
- Called by
- 2
Reaches the database via get_terms().
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 27.
Third-party callbacks on 'clean_taxonomy_cache' run inside this call, and their cost is not bounded by anything here.
2 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()called directly - optionoption read or write
delete_option()called directly - hookthird-party callbacks
do_action()called directly - querycontent query
get_terms()one call below clean_taxonomy_cache()
Further down the call graph this can also reach 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost clean_taxonomy_cache() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_taxonomy_hierarchical() | 20 | wp_cache_delete(), wp_cache_delete(), wp_cache_set_terms_last_changed(), is_taxonomy_hierarchical(), do_action() |
is_taxonomy_hierarchical() | 27 | wp_cache_delete(), wp_cache_delete(), wp_cache_set_terms_last_changed(), is_taxonomy_hierarchical(), delete_option(), _get_term_hierarchy(), 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: 27 instructions, 20–27 executed per call, 1 branch. 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_taxonomy_cache() runs, in this order:
- do_action( clean_taxonomy_cache )actionline 3747 (+18 into the body)
Fires after a taxonomy's caches have been cleaned.
Uses · 6
- wp_cache_delete()Removes the cache contents matching key and group.
- wp_cache_set_terms_last_changed()Sets the last changed time for the 'terms' cache group.
- is_taxonomy_hierarchical()Determines whether the taxonomy object is hierarchical.
- delete_option()Removes an option by name. Prevents removal of protected WordPress options.
- _get_term_hierarchy()Retrieves children of taxonomy as term IDs.
- do_action()Calls the callback functions that have been added to an action hook.
Used by · 2
- _split_shared_term()Creates a new term for a term_taxonomy item that currently shares its term with another term_taxonomy.
- clean_term_cache()Removes all of the term IDs from the cache.
Source code
function clean_taxonomy_cache( $taxonomy ) { wp_cache_delete( 'all_ids', $taxonomy ); wp_cache_delete( 'get', $taxonomy ); wp_cache_set_terms_last_changed(); // Regenerate cached hierarchy. if ( is_taxonomy_hierarchical( $taxonomy ) ) { delete_option( "{$taxonomy}_children" ); _get_term_hierarchy( $taxonomy ); } /** * Fires after a taxonomy's caches have been cleaned. * * @since 4.9.0 * * @param string $taxonomy Taxonomy slug. */ do_action( 'clean_taxonomy_cache', $taxonomy );}Changelog
Introduced in 4.9.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.