update_comment_cache()WP 2.3.0

Updates the comment cache of given comments.

Will add the comments in $comments to the cache. If comment ID already exists in the comment cache then it will not be updated. The comment is added to the cache using the comment group with the key using the ID of the comments.

No Hooks.

Return

null. Nothing (null).

Usage

update_comment_cache( $comments, $update_meta_cache );
$comments(WP_Comment[]) (required)
Array of comment objects
$update_meta_cache(true|false)
Whether to update commentmeta cache.
Default: true

Changelog

Since 2.3.0 Introduced.
Since 4.4.0 Introduced the $update_meta_cache parameter.

update_comment_cache() code WP 6.5.2

function update_comment_cache( $comments, $update_meta_cache = true ) {
	$data = array();
	foreach ( (array) $comments as $comment ) {
		$data[ $comment->comment_ID ] = $comment;
	}
	wp_cache_add_multiple( $data, 'comment' );

	if ( $update_meta_cache ) {
		// Avoid `wp_list_pluck()` in case `$comments` is passed by reference.
		$comment_ids = array();
		foreach ( $comments as $comment ) {
			$comment_ids[] = $comment->comment_ID;
		}
		update_meta_cache( 'comment', $comment_ids );
	}
}