clean_comment_cache() WordPress Function

The clean_comment_cache() function is used to clean the comment cache for a given post ID. This function is typically used when a post is updated and the comments need to be refreshed.

clean_comment_cache( int|array $ids ) #

Removes a comment from the object cache.


Parameters

$ids

(int|array)(Required)Comment ID or an array of comment IDs to remove from cache.


Top ↑

Source

File: wp-includes/comment.php

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( 'last_changed', microtime(), 'comment' );
}


Top ↑

Changelog

Changelog
VersionDescription
2.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More