wordpress / latest / functions / update_comment_cache.html

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

$comments WP_Comment[] Required
Array of comment objects
$update_meta_cache bool Optional
Whether to update commentmeta cache.

Default: true

Source

File: wp-includes/comment.php. View all references

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

Uses

Uses Description

Changelog

Version Description
4.4.0 Introduced the $update_meta_cache parameter.
2.3.0 Introduced.

© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/update_comment_cache