get_comments_number( int|WP_Post $post_id )
Retrieves the amount of comments a post has.
Parameters
- $post_id
-
(Optional) Post ID or WP_Post object. Default is the global
$post
.
Return
(string|int) If the post exists, a numeric string representing the number of comments the post has, otherwise 0.
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 WP-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 );
}
Changelog
Version | Description |
---|---|
WP-1.5.0 | Introduced. |