update_comment_cache( WP_Comment[] $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

$commentsWP_Comment[]required
Array of comment objects
$update_meta_cachebooloptional
Whether to update commentmeta cache.

Default:true

Source

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 );
	}
}

Changelog

VersionDescription
4.4.0Introduced the $update_meta_cache parameter.
2.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.