Comments: Add a $post_id parameter to get_comments_number_text() and comments_number().

This allow for using these functions outside of the loop.

Props donmhico, garrett-eclipse, Hinjiriyo, imath.
Fixes #48772.

git-svn-id: https://develop.svn.wordpress.org/trunk@47276 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-02-11 20:39:12 +00:00
parent c83253c7f8
commit 4020493d45
2 changed files with 28 additions and 11 deletions

View File

@ -870,30 +870,35 @@ function get_comments_number( $post_id = 0 ) {
* Displays the language string for the number of comments the current post has.
*
* @since 0.71
* @since 5.4.0 Added the `$post_id` parameter.
*
* @param string $zero Optional. Text for no comments. Default false.
* @param string $one Optional. Text for one comment. Default false.
* @param string $more Optional. Text for more than one comment. Default false.
* @param string $deprecated Not used.
* @param string $zero Optional. Text for no comments. Default false.
* @param string $one Optional. Text for one comment. Default false.
* @param string $more Optional. Text for more than one comment. Default false.
* @param string $deprecated Not used.
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is the global `$post`.
*/
function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
function comments_number( $zero = false, $one = false, $more = false, $deprecated = '', $post_id = 0 ) {
if ( ! empty( $deprecated ) ) {
_deprecated_argument( __FUNCTION__, '1.3.0' );
}
echo get_comments_number_text( $zero, $one, $more );
echo get_comments_number_text( $zero, $one, $more, $post_id );
}
/**
* Displays the language string for the number of comments the current post has.
*
* @since 4.0.0
* @since 5.4.0 Added the `$post_id` parameter to allow using the function outside of the loop.
*
* @param string $zero Optional. Text for no comments. Default false.
* @param string $one Optional. Text for one comment. Default false.
* @param string $more Optional. Text for more than one comment. Default false.
* @param string $zero Optional. Text for no comments. Default false.
* @param string $one Optional. Text for one comment. Default false.
* @param string $more Optional. Text for more than one comment. Default false.
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is the global `$post`.
* @return string Language string for the number of comments a post has.
*/
function get_comments_number_text( $zero = false, $one = false, $more = false ) {
$number = get_comments_number();
function get_comments_number_text( $zero = false, $one = false, $more = false, $post_id = 0 ) {
$number = get_comments_number( $post_id );
if ( $number > 1 ) {
if ( false === $more ) {

View File

@ -30,6 +30,18 @@ class Tests_Comment_Template extends WP_UnitTestCase {
$this->assertEquals( 12, get_comments_number() );
}
/**
* @ticket 48772
*/
function test_get_comments_number_text_with_post_id() {
$post_id = $this->factory->post->create();
$this->factory->comment->create_post_comments( $post_id, 6 );
$comments_number_text = get_comments_number_text( false, false, false, $post_id );
$this->assertEquals( sprintf( _n( '%s Comment', '%s Comments', 6 ), '6' ), $comments_number_text );
}
/**
* @ticket 13651
*/