clean_comment_cache( int|array $ids )
- Since
- 2.3.0
- Source
wp-includes/comment.php:3411
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|array- Comment ID or an array of comment IDs to remove from cache.
Performance profile
How much work a call to clean_comment_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
- 11–12
- Plugin surface
- 1 hook
- Called by
- 8
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 17.
Third-party callbacks on 'clean_comment_cache' run inside this call, and their cost is not bounded by anything here.
8 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
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost clean_comment_cache() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 11–12 | wp_cache_delete_multiple(), wp_cache_set_comments_last_changed() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 17 instructions, 11–12 executed per call, 2 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_comment_cache() runs, in this order:
- do_action( clean_comment_cache )actionline 3422 (+11 into the body)
Fires immediately after a comment has been removed from the object cache.
Uses · 3
- wp_cache_delete_multiple()Deletes multiple values from the cache in one call.
- do_action()Calls the callback functions that have been added to an action hook.
- wp_cache_set_comments_last_changed()Sets the last changed time for the 'comment' cache group.
Used by · 8
- _wp_batch_update_comment_type()Updates the comment type for a batch of comments.
- wp_comments_personal_data_eraser()Erases personal data associated with an email address from the comments table.
- wp_delete_comment()Trashes or deletes a comment.
- wp_insert_comment()Inserts a comment into the database.
- wp_set_comment_status()Sets the status of a comment.
- wp_trash_post_comments()Moves comments for a post to the Trash.
- wp_untrash_post_comments()Restores comments for a post from the Trash.
- wp_update_comment()Updates an existing comment in the database.
Source code
function clean_comment_cache( $ids ) { $comment_ids = (array) $ids; wp_cache_delete_multiple( $comment_ids, 'comment' ); foreach ( $comment_ids as $id ) { /** * Fires immediately after a comment has been removed from the object cache. * * @since 4.5.0 * * @param int $id Comment ID. */ do_action( 'clean_comment_cache', $id ); } wp_cache_set_comments_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/comment.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.