update_comment_cache( array $comments, bool $update_meta_cache = true )

Updates the comment cache of given comments.


Description

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.


Parameters

$comments

(Required) Array of comment row objects

$update_meta_cache

(Optional) Whether to update commentmeta cache.

Default value: true


Source

File: wp-includes/comment.php

function update_comment_cache( $comments, $update_meta_cache = true ) {
	foreach ( (array) $comments as $comment )
		wp_cache_add($comment->comment_ID, $comment, '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 );
	}
}


Changelog

Changelog
Version Description
WP-4.4.0 Introduced the $update_meta_cache parameter.
WP-2.3.0 Introduced.