comments_number() WordPress Function
The comments_number() function is used to display the number of comments on a post. It accepts two parameters: the first is the zero-based number of comments to display, and the second is the singular form of the word "comment" (e.g. "1 comment", "0 comments", "1,000 comments").
comments_number( string|false $zero = false, string|false $one = false, string|false $more = false, int|WP_Post $post_id ) #
Displays the language string for the number of comments the current post has.
Parameters
- $zero
(string|false)(Optional) Text for no comments.
Default value: false
- $one
(string|false)(Optional) Text for one comment.
Default value: false
- $more
(string|false)(Optional) Text for more than one comment.
Default value: false
- $post_id
(int|WP_Post)(Optional) Post ID or WP_Post object. Default is the global
$post
.
Source
File: wp-includes/comment-template.php
function comments_number( $zero = false, $one = false, $more = false, $post_id = 0 ) { echo get_comments_number_text( $zero, $one, $more, $post_id ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.4.0 | The $deprecated parameter was changed to $post_id . |
0.71 | Introduced. |