enmi-conf.org: comparison wp/wp-includes/class-wp-meta-query.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 	/**
 	 * Constructor.
 	 *
 	 * @since 3.2.0
 	 * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
-	 * @since 5.1.0 Introduced $compare_key clause parameter, which enables LIKE key matches.
+	 * @since 5.1.0 Introduced `$compare_key` clause parameter, which enables LIKE key matches.
-	 * @since 5.3.0 Increased the number of operators available to $compare_key. Introduced $type_key,
+	 * @since 5.3.0 Increased the number of operators available to `$compare_key`. Introduced `$type_key`,
-	 *              which enables the $key to be cast to a new data type for comparisons.
+	 *              which enables the `$key` to be cast to a new data type for comparisons.
 	 *
 	 * @param array $meta_query {
 	 *     Array of meta query clauses. When first-order clauses or sub-clauses use strings as
 	 *     their array keys, they may be referenced in the 'orderby' parameter of the parent query.
 	 *
-	 *     @type string $relation Optional. The MySQL keyword used to join
+	 *     @type string $relation Optional. The MySQL keyword used to join the clauses of the query.
-	 *                            the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
+	 *                            Accepts 'AND' or 'OR'. Default 'AND'.
 	 *     @type array  ...$0 {
 	 *         Optional. An array of first-order clause parameters, or another fully-formed meta query.
 	 *
-	 *         @type string $key         Meta key to filter by.
+	 *         @type string|string[] $key         Meta key or keys to filter by.
-	 *         @type string $compare_key MySQL operator used for comparing the $key. Accepts '=', '!='
+	 *         @type string          $compare_key MySQL operator used for comparing the $key. Accepts:
-	 *                                   'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'REGEXP', 'NOT REGEXP', 'RLIKE',
+	 *                                            - '='
-	 *                                   'EXISTS' (alias of '=') or 'NOT EXISTS' (alias of '!=').
+	 *                                            - '!='
-	 *                                   Default is 'IN' when `$key` is an array, '=' otherwise.
+	 *                                            - 'LIKE'
-	 *         @type string $type_key    MySQL data type that the meta_key column will be CAST to for
+	 *                                            - 'NOT LIKE'
-	 *                                   comparisons. Accepts 'BINARY' for case-sensitive regular expression
+	 *                                            - 'IN'
-	 *                                   comparisons. Default is ''.
+	 *                                            - 'NOT IN'
-	 *         @type string $value       Meta value to filter by.
+	 *                                            - 'REGEXP'
-	 *         @type string $compare     MySQL operator used for comparing the $value. Accepts '=',
+	 *                                            - 'NOT REGEXP'
-	 *                                   '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE',
+	 *                                            - 'RLIKE',
-	 *                                   'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'REGEXP',
+	 *                                            - 'EXISTS' (alias of '=')
-	 *                                   'NOT REGEXP', 'RLIKE', 'EXISTS' or 'NOT EXISTS'.
+	 *                                            - 'NOT EXISTS' (alias of '!=')
-	 *                                   Default is 'IN' when `$value` is an array, '=' otherwise.
+	 *                                            Default is 'IN' when `$key` is an array, '=' otherwise.
-	 *         @type string $type        MySQL data type that the meta_value column will be CAST to for
+	 *         @type string          $type_key    MySQL data type that the meta_key column will be CAST to for
-	 *                                   comparisons. Accepts 'NUMERIC', 'BINARY', 'CHAR', 'DATE',
+	 *                                            comparisons. Accepts 'BINARY' for case-sensitive regular expression
-	 *                                   'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', or 'UNSIGNED'.
+	 *                                            comparisons. Default is ''.
-	 *                                   Default is 'CHAR'.
+	 *         @type string|string[] $value       Meta value or values to filter by.
+	 *         @type string          $compare     MySQL operator used for comparing the $value. Accepts:
+	 *                                            - '=',
+	 *                                            - '!='
+	 *                                            - '>'
+	 *                                            - '>='
+	 *                                            - '<'
+	 *                                            - '<='
+	 *                                            - 'LIKE'
+	 *                                            - 'NOT LIKE'
+	 *                                            - 'IN'
+	 *                                            - 'NOT IN'
+	 *                                            - 'BETWEEN'
+	 *                                            - 'NOT BETWEEN'
+	 *                                            - 'REGEXP'
+	 *                                            - 'NOT REGEXP'
+	 *                                            - 'RLIKE'
+	 *                                            - 'EXISTS'
+	 *                                            - 'NOT EXISTS'
+	 *                                            Default is 'IN' when `$value` is an array, '=' otherwise.
+	 *         @type string          $type        MySQL data type that the meta_value column will be CAST to for
+	 *                                            comparisons. Accepts:
+	 *                                            - 'NUMERIC'
+	 *                                            - 'BINARY'
+	 *                                            - 'CHAR'
+	 *                                            - 'DATE'
+	 *                                            - 'DATETIME'
+	 *                                            - 'DECIMAL'
+	 *                                            - 'SIGNED'
+	 *                                            - 'TIME'
+	 *                                            - 'UNSIGNED'
+	 *                                            Default is 'CHAR'.
 	 *     }
 	 * }
 	 */
 	public function __construct( $meta_query = false ) {
 		if ( ! $meta_query ) {
 	/**
 	 * Generates SQL clauses to be appended to a main query.
 	 *
 	 * @since 3.2.0
 	 *
-	 * @param string $type              Type of meta, eg 'user', 'post'.
+	 * @param string $type              Type of meta. Possible values include but are not limited
+	 *                                  to 'post', 'comment', 'blog', 'term', and 'user'.
 	 * @param string $primary_table     Database table where the object being filtered is stored (eg wp_users).
 	 * @param string $primary_id_column ID column for the filtered object in $primary_table.
-	 * @param object $context           Optional. The main query object.
+	 * @param object $context           Optional. The main query object that corresponds to the type, for
-	 * @return array|false {
+	 *                                  example a `WP_Query`, `WP_User_Query`, or `WP_Site_Query`.
-	 *     Array containing JOIN and WHERE SQL clauses to append to the main query.
+	 * @return string[]|false {
+	 *     Array containing JOIN and WHERE SQL clauses to append to the main query,
+	 *     or false if no table exists for the requested meta type.
 	 *
 	 *     @type string $join  SQL fragment to append to the main JOIN clause.
 	 *     @type string $where SQL fragment to append to the main WHERE clause.
 	 * }
 	 */
 		/**
 		 * Filters the meta query's generated SQL.
 		 *
 		 * @since 3.1.0
 		 *
-		 * @param array  $sql               Array containing the query's JOIN and WHERE clauses.
+		 * @param string[] $sql               Array containing the query's JOIN and WHERE clauses.
-		 * @param array  $queries           Array of meta queries.
+		 * @param array    $queries           Array of meta queries.
-		 * @param string $type              Type of meta.
+		 * @param string   $type              Type of meta. Possible values include but are not limited
-		 * @param string $primary_table     Primary table.
+		 *                                    to 'post', 'comment', 'blog', 'term', and 'user'.
-		 * @param string $primary_id_column Primary column ID.
+		 * @param string   $primary_table     Primary table.
-		 * @param object $context           The main query object.
+		 * @param string   $primary_id_column Primary column ID.
+		 * @param object   $context           The main query object that corresponds to the type, for
+		 *                                    example a `WP_Query`, `WP_User_Query`, or `WP_Site_Query`.
 		 */
 		return apply_filters_ref_array( 'get_meta_sql', array( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) );
 	}
 	/**
 	 * Called by the public WP_Meta_Query::get_sql(), this method is abstracted
 	 * out to maintain parity with the other Query classes.
 	 *
 	 * @since 4.1.0
 	 *
-	 * @return array {
+	 * @return string[] {
 	 *     Array containing JOIN and WHERE SQL clauses to append to the main query.
 	 *
 	 *     @type string $join  SQL fragment to append to the main JOIN clause.
 	 *     @type string $where SQL fragment to append to the main WHERE clause.
 	 * }
 	 * @since 4.1.0
 	 *
 	 * @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. Default 0.
-	 * @return array {
+	 * @return string[] {
 	 *     Array containing JOIN and WHERE SQL clauses to append to a single query array.
 	 *
 	 *     @type string $join  SQL fragment to append to the main JOIN clause.
 	 *     @type string $where SQL fragment to append to the main WHERE clause.
 	 * }
 	 *
 	 * @param array  $clause       Query clause (passed by reference).
 	 * @param array  $parent_query Parent query array.
 	 * @param string $clause_key   Optional. The array key used to name the clause in the original `$meta_query`
 	 *                             parameters. If not provided, a key will be generated automatically.
-	 * @return array {
+	 * @return string[] {
 	 *     Array containing JOIN and WHERE SQL clauses to append to a first-order query.
 	 *
 	 *     @type string $join  SQL fragment to append to the main JOIN clause.
 	 *     @type string $where SQL fragment to append to the main WHERE clause.
 	 * }
 			if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ), true ) ) {
 				if ( ! is_array( $meta_value ) ) {
 					$meta_value = preg_split( '/[,\s]+/', $meta_value );
 				}
-			} else {
+			} elseif ( is_string( $meta_value ) ) {
 				$meta_value = trim( $meta_value );
 			}
 			switch ( $meta_compare ) {
 				case 'IN':
 			}
 			$clause_compare  = strtoupper( $clause['compare'] );
 			$sibling_compare = strtoupper( $sibling['compare'] );
 			if ( in_array( $clause_compare, $compatible_compares, true ) && in_array( $sibling_compare, $compatible_compares, true ) ) {
-				$alias = $sibling['alias'];
+				$alias = preg_replace( '/\W/', '_', $sibling['alias'] );
 				break;
 			}
 		}
 		/**
 		 * @since 4.1.0
 		 *
 		 * @param string|false  $alias        Table alias, or false if none was found.
 		 * @param array         $clause       First-order query clause.
 		 * @param array         $parent_query Parent of $clause.
-		 * @param WP_Meta_Query $this         WP_Meta_Query object.
+		 * @param WP_Meta_Query $query        WP_Meta_Query object.
 		 */
 		return apply_filters( 'meta_query_find_compatible_table_alias', $alias, $clause, $parent_query, $this );
 	}
 	/**

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6