A WordPress-centric search engine for devs and theme authors



get_comments_number ›

Since1.5.0
Deprecatedn/a
get_comments_number ( $post_id = 0 )
Parameters:
  • (int|WP_Post) $post_id Optional. Post ID or WP_Post object. Default is the global `$post`.
    Required: No
    Default:
Returns:
  • (string|int) If the post exists, a numeric string representing the number of comments the post has, otherwise 0.
Defined at:
Codex:

Retrieves the amount of comments a post has.



Source

function get_comments_number( $post_id = 0 ) {
	$post = get_post( $post_id );

	if ( ! $post ) {
		$count = 0;
	} else {
		$count   = $post->comment_count;
		$post_id = $post->ID;
	}

	/**
	 * Filters the returned comment count for a post.
	 *
	 * @since 1.5.0
	 *
	 * @param string|int $count   A string representing the number of comments a post has, otherwise 0.
	 * @param int        $post_id Post ID.
	 */
	return apply_filters( 'get_comments_number', $count, $post_id );
}