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.
Built from https://develop.svn.wordpress.org/trunk@58454


git-svn-id: http://core.svn.wordpress.org/trunk@57903 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
hellofromTonya 2024-06-21 17:26:14 +00:00
parent 953941b344
commit 754f50d1b9
4 changed files with 31 additions and 4 deletions

View File

@ -927,7 +927,16 @@ class WP_Comment_Query {
* *
* @since 3.1.0 * @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). * @param WP_Comment_Query $query Current instance of WP_Comment_Query (passed by reference).
*/ */
$clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) ); $clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) );

View File

@ -446,7 +446,16 @@ class WP_Network_Query {
* *
* @since 4.6.0 * @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). * @param WP_Network_Query $query Current instance of WP_Network_Query (passed by reference).
*/ */
$clauses = apply_filters_ref_array( 'networks_clauses', array( compact( $pieces ), &$this ) ); $clauses = apply_filters_ref_array( 'networks_clauses', array( compact( $pieces ), &$this ) );

View File

@ -660,7 +660,16 @@ class WP_Site_Query {
* *
* @since 4.6.0 * @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). * @param WP_Site_Query $query Current instance of WP_Site_Query (passed by reference).
*/ */
$clauses = apply_filters_ref_array( 'sites_clauses', array( compact( $pieces ), &$this ) ); $clauses = apply_filters_ref_array( 'sites_clauses', array( compact( $pieces ), &$this ) );

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.6-beta3-58453'; $wp_version = '6.6-beta3-58454';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.