get_comments_number( int|WP_Post $post_id )

Retrieves the amount of comments a post has.


Description Description


Parameters Parameters

$post_id

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


Top ↑

Return Return

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


Top ↑

Source Source

File: wp-includes/comment-template.php

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

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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