Changeset 28602

Timestamp:

05/28/2014 10:04:59 PM (11 years ago)

Author:

DrewAPicture

Message:

Fix parameter description for the $post_id argument in get_comments_number() to note that it is optional.

Also fixes the corresponding filter docs, as $post_id, not $post is passed to the filter.

See [27156]. Fixes #26240.

File:

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

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

@@ -679 +679 @@
  * @since 1.5.0
  *
- * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
+ * @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.
  */
@@ -697 +697 @@
      *
      * @param int         $count   Nnumber of comments a post has.
-     * @param int|WP_Post $post_id Post ID or WP_Post object.
+     * @param int $post_id Post ID.
      */
     return apply_filters( 'get_comments_number', $count, $post_id );