wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_count_comments › WordPress Function

Since2.5.0
Deprecatedn/a
› wp_count_comments ( $post_id = 0 )
Parameters:
  • (int) $post_id Optional. Restrict the comment counts to the given post. Default 0, which indicates that comment counts for the whole site will be retrieved.
    Required: No
    Default: —
See:
Returns:
  • (stdClass) { The number of comments keyed by their status. @type int $approved The number of approved comments. @type int $moderated The number of comments awaiting moderation (a.k.a. pending). @type int $spam The number of spam comments. @type int $trash The number of trashed comments. @type int $post-trashed The number of comments for posts that are in the trash. @type int $total_comments The total number of non-trashed comments, including spam. @type int $all The total number of pending or approved comments. }
Defined at:
Codex:

Retrieves the total comment counts for the whole site or a single post.

The comment stats are cached and then retrieved, if they already exist in the cache.


Related Functions: wp_count_attachments, wp_untrash_comment, wp_list_comments, wp_new_comment, wp_count_posts

Source 

function wp_count_comments( $post_id = 0 ) {
	$post_id = (int) $post_id;

	/**
	 * Filters the comments count for a given post or the whole site.
	 *
	 * @since 2.7.0
	 *
	 * @param array|stdClass $count   An empty array or an object containing comment counts.
	 * @param int            $post_id The post ID. Can be 0 to represent the whole site.
	 */
	$filtered = apply_filters( 'wp_count_comments', array(), $post_id );
	if ( ! empty( $filtered ) ) {
		return $filtered;
	}

	$count = wp_cache_get( "comments-{$post_id}", 'counts' );
	if ( false !== $count ) {
		return $count;
	}

	$stats              = get_comment_count( $post_id );
	$stats['moderated'] = $stats['awaiting_moderation'];
	unset( $stats['awaiting_moderation'] );

	$stats_object = (object) $stats;
	wp_cache_set( "comments-{$post_id}", $stats_object, 'counts' );

	return $stats_object;
}