Ticket #30111: 30111.patch

src/wp-includes/comment.php

@@ -270 +270 @@
          *              'post_author__not_in', 'author__in', 'author__not_in',
          *              'post__in', 'post__not_in', and 'include_unapproved' to $query_vars.
          *
-         * @param string|array $query_vars
+         * @param string|array $query_vars {
+         *     Array or comma-separated list of query parameters.
+         *     @type string       $author_email        Optional. Email address of the comment author.
+         *     @type array        $author__in          Optional. Array of author IDs to include.
+         *     @type array        $author__not_in      Optional. Author IDs to exclude.
+         *     @type array        $include_unapproved  Optional. IDs or email addresses of users whose unapproved
+         *                                             comments will be returned by the query, regardless of $status.
+         *     @type string       $fields              Optional. Comment fields to return. 'ids' for comment IDs only.
+         *     @type int          $ID                  Currently unused.
+         *     @type array        $comment__in         Optional. Array of comment IDs to include.
+         *     @type array        $comment__not_in     Optional. Array of comment IDs to exclude.
+         *     @type int          $karma               Optional. comment_karma value to match.
+         *     @type int          $number              Optional. Max comments to return. Defaults to null (no limit).
+         *     @type int          $offset              Optional. Offset used to build LIMIT clause. Defaults to 0.
+         *     @type string|array $orderby             Comment status(es). Accepts 'comment_agent', 'comment_approved',
+         *                                             'comment_author', 'comment_author_email', 'comment_author_IP',
+         *                                             'comment_author_url', 'comment_content', 'comment_date',
+         *                                             'comment_date_gmt', 'comment_ID', 'comment_karma',
+         *                                             'comment_parent', 'comment_post_ID', 'comment_type', 'user_id',
+         *                                             'meta_value', 'meta_value_num', or value of $meta_key.
+         *                                             Accepts false, empty array, or 'none' to disable ORDER BY
+         *                                             clause. Default: 'comment_date_gmt'.
+         *     @type string       $order               Order of returned clauses. Accepts 'ASC', 'DESC'.
+         *                                             Default: 'DESC'.
+         *     @type int          $parent              Optional. Comment parent.
+         *     @type array        $post_author__in     Optional. Return comments limited
+         *                                             by ID of affiliated post author.
+         *     @type array        $post_author__not_in Optional. Exclude comments by ID of affiliated post author.
+         *     @type int          $post_ID             Currently unused.
+         *     @type int          $post_id             Optional. Limit results to those affiliated with a given post.
+         *     @type array        $post__in            Optional. Include comments affiliated with an
+         *                                             array of post IDs.
+         *     @type array        $post__not_in        Optional. Exclude comments affiliated with an
+         *                                             array of post IDs.
+         *     @type int          $post_author         Optional. Include comments from post by a given author.
+         *     @type string       $post_status         Optional. Include comments associated with posts
+         *                                             that have a given post_status.
+         *     @type string       $post_type           Optional. Include comments associated with posts
+         *                                             that have a given post_type.
+         *     @type string       $post_name           Optional. Include comments associated with posts
+         *                                             that have a given post_name.
+         *     @type string       $post_parent         Optional. Include comments associated with posts
+         *                                             that have a given post_parent.
+         *     @type string       $status              Include comments with a given status. Accepts
+         *                                             'hold' (comment_status=0), 'approve' (comment_status=1), 'all',
+         *                                             or a custom comment status.
+         *     @type string       $type                Optional. Include comments of a given type. Accepts 'comment',
+         *                                             'pings' (includes 'pingback' and 'trackback') or any
+         *                                             custom type string.
+         *     @type int          $user_id             Optional. Include comments by a specific user.
+         *     @type string       $search              Optional. Include comments matching a search string.
+         *     @type bool         $count               True to return a comment count, false to return an array of
+         *                                             comment objects. Default: false.
+         *     @type string       $meta_key            Optional. Include comments with commentmeta matching a
+         *                                             given meta_key.
+         *     @type string       $meta_value          Optional. Include comments with commentmeta matching a
+         *                                             given meta_value. Can be used with $meta_key.
+         *     @type array        $meta_query          An array of meta query clauses. See {@link WP_Meta_Query}.
+         *     @type array        $date_query          An array of date query clauses. See {@link WP_Date_Query}.
+         * }
          * @return int|array
          */
         public function query( $query_vars ) {