Changeset 41285 for trunk/src/wp-includes/comment-template.php

Timestamp:

08/20/2017 08:12:50 PM (7 years ago)

Author:

DrewAPicture

Message:

Docs: Clarify that get_comments_number() can return either a numeric string (for compatibility reasons) or 0 if the post doesn't exist.

Also update the hook doc for the get_comments_number filter to reflect the mixed type for $count.

Props kiranpotphode for the initial patch.
Fixes #38369.

File:

• trunk/src/wp-includes/comment-template.php (modified) (2 diffs)

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

@@ -831 +831 @@
 
 /**
- * Retrieve the amount of comments a post has.
+ * Retrieves the amount of comments a post has.
  *
  * @since 1.5.0
  *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
- * @return int The number of comments a post has.
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is the global `$post`.
+ * @return string|int If the post exists, a numeric string representing the number of comments
+ *                    the post has, otherwise 0.
  */
 function get_comments_number( $post_id = 0 ) {
@@ -853 +854 @@
      * @since 1.5.0
      *
-     * @param int $count   Number of comments a post has.
-     * @param int $post_id Post ID.
+     * @param string|int $count   A string representing the number of comments a post has, otherwise 0.
+     * @param int        $post_id Post ID.
      */
     return apply_filters( 'get_comments_number', $count, $post_id );