Changeset 31795

Timestamp:

03/16/2015 08:17:35 PM (10 years ago)

Author:

DrewAPicture

Message:

Move the default arguments hash notation for WP_Comment_Query to the new constructor, where the argument definitions were moved in [31793].

Core style dictates that the default arguments should be documented in the same function or method where they are defined.

See [31793].
Fixes #24826.

File:

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

trunk/src/wp-includes/comment.php

@@ -233 +233 @@
  * WordPress Comment Query class.
  *
- * See {@see WP_Comment_Query::query()} for accepted arguments.
+ * See WP_Comment_Query::__construct() for accepted arguments.
  *
  * @since 3.1.0
@@ -317 +317 @@
      * @access public
      *
-     * @param string $query URL query string.
-     * @return WP_Comment_Query
-     */
-    public function __construct( $query = '' ) {
-        $this->query_var_defaults = array(
-            'author_email' => '',
-            'author__in' => '',
-            'author__not_in' => '',
-            'include_unapproved' => '',
-            'fields' => '',
-            'ID' => '',
-            'comment__in' => '',
-            'comment__not_in' => '',
-            'karma' => '',
-            'number' => '',
-            'offset' => '',
-            'orderby' => '',
-            'order' => 'DESC',
-            'parent' => '',
-            'post_author__in' => '',
-            'post_author__not_in' => '',
-            'post_ID' => '',
-            'post_id' => 0,
-            'post__in' => '',
-            'post__not_in' => '',
-            'post_author' => '',
-            'post_name' => '',
-            'post_parent' => '',
-            'post_status' => '',
-            'post_type' => '',
-            'status' => 'all',
-            'type' => '',
-            'type__in' => '',
-            'type__not_in' => '',
-            'user_id' => '',
-            'search' => '',
-            'count' => false,
-            'meta_key' => '',
-            'meta_value' => '',
-            'meta_query' => '',
-            'date_query' => null, // See WP_Date_Query
-        );
-
-        if ( ! empty( $query ) ) {
-            $this->query( $query );
-        }
-    }
-
-    /**
-     * Parse arguments passed to the comment query with default query parameters.
-     *
-     * @since  4.2.0 Extracted from {@link WP_Comment_Query::query()}.
-     * @access public
-     *
      * @param string|array $query {
-     *     Optional. Array or query string of comment query parameters.
+     *     Optional. Array or query string of comment query parameters. Default empty.
      *
      *     @type string       $author_email        Comment author email address. Default empty.
@@ -381 +327 @@
      *     @type bool         $count               Whether to return a comment count (true) or array of comment
      *                                             objects (false). Default false.
-     *     @type array        $date_query          Date query clauses to limit comments by. See {@see WP_Date_Query}.
+     *     @type array        $date_query          Date query clauses to limit comments by. See WP_Date_Query.
      *                                             Default null.
      *     @type string       $fields              Comment fields to return. Accepts 'ids' for comment IDs only or
@@ -393 +339 @@
      *                                             `$meta_key` to be set. Default empty.
      *     @type array        $meta_query          Meta query clauses to limit retrieved comments by.
-     *                                             See {@see WP_Meta_Query}. Default empty.
+     *                                             See WP_Meta_Query. Default empty.
      *     @type int          $number              Maximum number of comments to retrieve. Default null (no limit).
      *     @type int          $offset              Number of comments to offset the query. Used to build LIMIT clause.
@@ -434 +380 @@
      *     @type int          $user_id             Include comments for a specific user ID. Default empty.
      * }
+     * @return WP_Comment_Query WP_Comment_Query instance.
+     */
+    public function __construct( $query = '' ) {
+        $this->query_var_defaults = array(
+            'author_email' => '',
+            'author__in' => '',
+            'author__not_in' => '',
+            'include_unapproved' => '',
+            'fields' => '',
+            'ID' => '',
+            'comment__in' => '',
+            'comment__not_in' => '',
+            'karma' => '',
+            'number' => '',
+            'offset' => '',
+            'orderby' => '',
+            'order' => 'DESC',
+            'parent' => '',
+            'post_author__in' => '',
+            'post_author__not_in' => '',
+            'post_ID' => '',
+            'post_id' => 0,
+            'post__in' => '',
+            'post__not_in' => '',
+            'post_author' => '',
+            'post_name' => '',
+            'post_parent' => '',
+            'post_status' => '',
+            'post_type' => '',
+            'status' => 'all',
+            'type' => '',
+            'type__in' => '',
+            'type__not_in' => '',
+            'user_id' => '',
+            'search' => '',
+            'count' => false,
+            'meta_key' => '',
+            'meta_value' => '',
+            'meta_query' => '',
+            'date_query' => null, // See WP_Date_Query
+        );
+
+        if ( ! empty( $query ) ) {
+            $this->query( $query );
+        }
+    }
+
+    /**
+     * Parse arguments passed to the comment query with default query parameters.
+     *
+     * @since  4.2.0 Extracted from WP_Comment_Query::query().
+     *
+     * @access public
+     *
+     * @param string|array $query WP_Comment_Query arguments. See WP_Comment_Query::__construct()
      */
     public function parse_query( $query = '' ) {