A WordPress-centric search engine for devs and theme authors

update_comment_cache › WordPress Function

update_comment_cache ( $comments, $update_meta_cache = true )
Parameters: (2)
  • (WP_Comment[]) $comments Array of comment objects
    Required: Yes
  • (bool) $update_meta_cache Whether to update commentmeta cache. Default true.
    Required: No
    Default: true
Defined at:
Change Log:
  • 4.4.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.


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