Retrieves the amount of comments a post has.

Parameters

$postint|WP_Postoptional

Post ID or WP_Post object. Default is the global $post.

Return

Source

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

	$comments_number = $post ? $post->comment_count : 0;
	$post_id         = $post ? $post->ID : 0;

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_comments_number’, string|int $comments_number, int $post_id )

Filters the returned comment count for a post.

Changelog