Changeset 47366

Timestamp:

02/25/2020 05:32:34 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Comments: Restore the fourth parameter of comments_number() as $post_id, for consistency with get_comments_number_text().

The parameter was previously used as the number of comments, marked as deprecated in [5101].

Given that it's been deprecated for the last 13 years, it should be safe to undeprecate and repurpose it for a cleaner function signature, instead of adding a fifth parameter.

Follow-up to [47276].

Fixes #48772.

Location:

trunk

Files:

• src/wp-includes/comment-template.php (modified) (1 diff)
• tests/phpunit/tests/comment/template.php (modified) (1 diff)

trunk/src/wp-includes/comment-template.php

@@ -871 +871 @@
  *
  * @since 0.71
- * @since 5.4.0 Added the `$post_id` parameter.
+ * @since 5.4.0 The `$deprecated` parameter was changed to `$post_id`.
  *
  * @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 = '', $post_id = 0 ) {
-    if ( ! empty( $deprecated ) ) {
-        _deprecated_argument( __FUNCTION__, '1.3.0' );
-    }
+function comments_number( $zero = false, $one = false, $more = false, $post_id = 0 ) {
     echo get_comments_number_text( $zero, $one, $more, $post_id );
 }

trunk/tests/phpunit/tests/comment/template.php

@@ -41 +41 @@
 
         $this->assertEquals( sprintf( _n( '%s Comment', '%s Comments', 6 ), '6' ), $comments_number_text );
+
+        ob_start();
+        comments_number( false, false, false, $post_id );
+        $comments_number_text = ob_get_clean();
+
+        $this->assertEquals( sprintf( _n( '%s Comment', '%s Comments', 6 ), '6' ), $comments_number_text );
+
     }