From f6fd6e09b19d01c6342f0df39ff4fa35983bed8e Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 28 Nov 2014 12:02:22 +0000 Subject: [PATCH] 4.1 Docs Audit: Improve inline documentation for various `WP_Meta_Query` methods introduced or modified in 4.1. See #30469. Built from https://develop.svn.wordpress.org/trunk@30617 git-svn-id: http://core.svn.wordpress.org/trunk@30607 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/meta.php | 23 +++++++++++++---------- wp-includes/version.php | 2 +- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/wp-includes/meta.php b/wp-includes/meta.php index f3415ad663..91248c9816 100644 --- a/wp-includes/meta.php +++ b/wp-includes/meta.php @@ -978,7 +978,7 @@ class WP_Meta_Query { } /** - * Ensure the `meta_query` argument passed to the class constructor is well-formed. + * Ensure the 'meta_query' argument passed to the class constructor is well-formed. * * Eliminates empty items and ensures that a 'relation' is set. * @@ -1231,9 +1231,9 @@ class WP_Meta_Query { * @since 4.1.0 * @access protected * - * @param array $query Query to parse. + * @param array $query Query to parse, passed by reference. * @param int $depth Optional. Number of tree levels deep we currently are. - * Used to calculate indentation. + * Used to calculate indentation. Default 0. * @return array { * Array containing JOIN and WHERE SQL clauses to append to a single query array. * @@ -1315,7 +1315,7 @@ class WP_Meta_Query { * @since 4.1.0 * @access public * - * @param array $clause Query clause. + * @param array $clause Query clause, passed by reference. * @param array $parent_query Parent query array. * @return array { * Array containing JOIN and WHERE SQL clauses to append to a first-order query. @@ -1446,15 +1446,18 @@ class WP_Meta_Query { } /** - * Identify an existing table alias that is compatible with the current query clause. + * Identify an existing table alias that is compatible with the current + * query clause. * * We avoid unnecessary table joins by allowing each clause to look for * an existing table alias that is compatible with the query that it - * needs to perform. An existing alias is compatible if (a) it is a - * sibling of $clause (ie, it's under the scope of the same relation), - * and (b) the combination of operator and relation between the clauses - * allows for a shared table join. In the case of WP_Meta_Query, this - * only applies to IN clauses that are connected by the relation OR. + * needs to perform. + * + * An existing alias is compatible if (a) it is a sibling of `$clause` + * (ie, it's under the scope of the same relation), and (b) the combination + * of operator and relation between the clauses allows for a shared table join. + * In the case of {@see WP_Meta_Query}, this only applies to 'IN' clauses that + * are connected by the relation 'OR'. * * @since 4.1.0 * @access protected diff --git a/wp-includes/version.php b/wp-includes/version.php index ad470f8c1e..ebcc5aed0f 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.1-beta2-30616'; +$wp_version = '4.1-beta2-30617'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.