get_comments_number_text() │ WP 4.0.0
Displays the language string for the number of comments the current post has.
Return
String
. Language string for the number of comments a post has.
Usage
get_comments_number_text( $zero, $one, $more, $post );
- $zero(string)
- Text for no comments.
Default: false
- $one(string)
- Text for one comment.
Default: false
- $more(string)
- Text for more than one comment.
Default: false
- $post(int|WP_Post)
- Post ID or WP_Post object.
Default: global $post
Examples
#1 Number of comments on the article
Let's display the number of comments on the current post and specify what text to write, with a certain number of comments.
<p>
This post has <?php echo get_comments_number_text( 'no comments yet', '1 comment', '% comments' ); ?>.
</p>
Changelog
Since 4.0.0 |
Introduced. |
Since 5.4.0 |
Added the $post parameter to allow using the function outside of the loop. |
get_comments_number_text() get comments number text code
WP 6.7.1
function get_comments_number_text( $zero = false, $one = false, $more = false, $post = 0 ) {
$comments_number = get_comments_number( $post );
if ( $comments_number > 1 ) {
if ( false === $more ) {
$comments_number_text = sprintf(
/* translators: %s: Number of comments. */
_n( '%s Comment', '%s Comments', $comments_number ),
number_format_i18n( $comments_number )
);
} else {
// % Comments
/*
* translators: If comment number in your language requires declension,
* translate this to 'on'. Do not translate into your own language.
*/
if ( 'on' === _x( 'off', 'Comment number declension: on or off' ) ) {
$text = preg_replace( '#<span class="screen-reader-text">.+?</span>#', '', $more );
$text = preg_replace( '/&.+?;/', '', $text ); // Remove HTML entities.
$text = trim( strip_tags( $text ), '% ' );
// Replace '% Comments' with a proper plural form.
if ( $text && ! preg_match( '/[0-9]+/', $text ) && str_contains( $more, '%' ) ) {
/* translators: %s: Number of comments. */
$new_text = _n( '%s Comment', '%s Comments', $comments_number );
$new_text = trim( sprintf( $new_text, '' ) );
$more = str_replace( $text, $new_text, $more );
if ( ! str_contains( $more, '%' ) ) {
$more = '% ' . $more;
}
}
}
$comments_number_text = str_replace( '%', number_format_i18n( $comments_number ), $more );
}
} elseif ( 0 == $comments_number ) {
$comments_number_text = ( false === $zero ) ? __( 'No Comments' ) : $zero;
} else { // Must be one.
$comments_number_text = ( false === $one ) ? __( '1 Comment' ) : $one;
}
/**
* Filters the comments count for display.
*
* @since 1.5.0
*
* @see _n()
*
* @param string $comments_number_text A translatable string formatted based on whether the count
* is equal to 0, 1, or 1+.
* @param int $comments_number The number of post comments.
*/
return apply_filters( 'comments_number', $comments_number_text, $comments_number );
}
Related Functions