get_comments_number( int|WP_Post $post ): string|int

Retrieves the amount of comments a post has.


Parameters

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

Top ↑

Return

string|int If the post exists, a numeric string representing the number of comments the post has, otherwise 0.


Top ↑

Source

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

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

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.