Changeset 47276

Timestamp:

02/11/2020 08:39:12 PM (5 years ago)

Author:

SergeyBiryukov

Message:

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.

Location:

trunk

Files:

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

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

@@ -871 +871 @@
  *
  * @since 0.71
- *
- * @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.
- */
-function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
+ * @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 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' );
     }
-    echo get_comments_number_text( $zero, $one, $more );
+    echo get_comments_number_text( $zero, $one, $more, $post_id );
 }
 
@@ -888 +890 @@
  *
  * @since 4.0.0
- *
- * @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.
- */
-function get_comments_number_text( $zero = false, $one = false, $more = false ) {
-    $number = get_comments_number();
+ * @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 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, $post_id = 0 ) {
+    $number = get_comments_number( $post_id );
 
     if ( $number > 1 ) {

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

@@ -29 +29 @@
 
         $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 );
     }