Changeset 58454

Timestamp:

06/21/2024 05:24:39 PM (2 years ago)

Author:

hellofromTonya

Message:

Docs: Document $clauses associative array in *-clauses filters.

Document each element within the filter parameter $clauses associative array structure for the 'comments_clauses', 'networks_clauses', and 'sites_clauses' filters.

This change:

• Brings consistency amongst the WP_[*_]Query filters.
• Helps to improve understanding.
• Helps to avoid confusion of the purpose for pieces and clauses.

Follow-up to [53376], [53375], [52974].

Props david.binda, audrasjb, hellofromTonya, ironprogrammer, johnbillion, oglekler, SergeyBiryukov.
Fixes #61307.

Location:

trunk/src/wp-includes

Files:

• class-wp-comment-query.php (modified) (1 diff)
• class-wp-network-query.php (modified) (1 diff)
• class-wp-site-query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-comment-query.php

@@ -928 +928 @@
                  * @since 3.1.0
                  *
-                 * @param string[]         $clauses An associative array of comment query clauses.
+                 * @param string[]         $clauses {
+                 *     Associative array of the clauses for the query.
+                 *
+                 *     @type string $fields   The SELECT clause of the query.
+                 *     @type string $join     The JOIN clause of the query.
+                 *     @type string $where    The WHERE clause of the query.
+                 *     @type string $orderby  The ORDER BY clause of the query.
+                 *     @type string $limits   The LIMIT clause of the query.
+                 *     @type string $groupby  The GROUP BY clause of the query.
+                 * }
                  * @param WP_Comment_Query $query   Current instance of WP_Comment_Query (passed by reference).
                  */

trunk/src/wp-includes/class-wp-network-query.php

@@ -447 +447 @@
                  * @since 4.6.0
                  *
-                 * @param string[]         $clauses An associative array of network query clauses.
+                 * @param string[]         $clauses {
+                 *     Associative array of the clauses for the query.
+                 *
+                 *     @type string $fields   The SELECT clause of the query.
+                 *     @type string $join     The JOIN clause of the query.
+                 *     @type string $where    The WHERE clause of the query.
+                 *     @type string $orderby  The ORDER BY clause of the query.
+                 *     @type string $limits   The LIMIT clause of the query.
+                 *     @type string $groupby  The GROUP BY clause of the query.
+                 * }
                  * @param WP_Network_Query $query   Current instance of WP_Network_Query (passed by reference).
                  */

trunk/src/wp-includes/class-wp-site-query.php

@@ -661 +661 @@
                  * @since 4.6.0
                  *
-                 * @param string[]      $clauses An associative array of site query clauses.
+                 * @param string[]      $clauses {
+                 *     Associative array of the clauses for the query.
+                 *
+                 *     @type string $fields   The SELECT clause of the query.
+                 *     @type string $join     The JOIN clause of the query.
+                 *     @type string $where    The WHERE clause of the query.
+                 *     @type string $orderby  The ORDER BY clause of the query.
+                 *     @type string $limits   The LIMIT clause of the query.
+                 *     @type string $groupby  The GROUP BY clause of the query.
+                 * }
                  * @param WP_Site_Query $query   Current instance of WP_Site_Query (passed by reference).
                  */