Changeset 42768 for trunk/src/wp-includes/class-wp-meta-query.php

Timestamp:

03/01/2018 04:02:41 AM (8 years ago)

Author:

boonebgorges

Message:

Allow LIKE queries against the 'key' value in meta queries.

The new compare_key=LIKE parameter works in conjunction with key in a
similar way to the compare=LIKE and value: by doing a "compares" LIKE
query. This allows developers to do partial matches against keys when
doing meta queries.

Props mariovalney, chasewg.
Fixes #42409.

File:

• trunk/src/wp-includes/class-wp-meta-query.php (modified) (6 diffs)

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

@@ -100 +100 @@
      * @since 3.2.0
      * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
+     * @since 5.0.0 Introduced $compare_key clause parameter, which enables LIKE key matches.
      *
      * @param array $meta_query {
@@ -110 +111 @@
      *         Optional. An array of first-order clause parameters, or another fully-formed meta query.
      *
-     *         @type string $key     Meta key to filter by.
-     *         @type string $value   Meta value 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' or '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', or 'UNSIGNED'.
-     *                               Default is 'CHAR'.
+     *         @type string $key         Meta key to filter by.
+     *         @type string $compare_key MySQL operator used for comparing the $key. Accepts '=' and 'LIKE'.
+     *                                   Default '='.
+     *         @type string $value       Meta value 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' or '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', or 'UNSIGNED'.
+     *                                   Default is 'CHAR'.
      *     }
      * }
@@ -237 +240 @@
          */
         $primary_meta_query = array();
-        foreach ( array( 'key', 'compare', 'type' ) as $key ) {
+        foreach ( array( 'key', 'compare', 'type', 'compare_key' ) as $key ) {
             if ( ! empty( $qv[ "meta_$key" ] ) ) {
                 $primary_meta_query[ $key ] = $qv[ "meta_$key" ];
@@ -519 +522 @@
         }
 
-        $meta_compare = $clause['compare'];
+        if ( isset( $clause['compare_key'] ) && 'LIKE' === strtoupper( $clause['compare_key'] ) ) {
+            $clause['compare_key'] = strtoupper( $clause['compare_key'] );
+        } else {
+            $clause['compare_key'] = '=';
+        }
+
+        $meta_compare     = $clause['compare'];
+        $meta_compare_key = $clause['compare_key'];
 
         // First build the JOIN clause, if one is required.
@@ -534 +544 @@
                 $join .= " LEFT JOIN $this->meta_table";
                 $join .= $i ? " AS $alias" : '';
-                $join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );
+
+                if ( 'LIKE' === $meta_compare_key ) {
+                    $join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key LIKE %s )", '%' . $wpdb->esc_like( $clause['key'] ) . '%' );
+                } else {
+                    $join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );
+                }
 
                 // All other JOIN clauses.
@@ -578 +593 @@
                 $sql_chunks['where'][] = $alias . '.' . $this->meta_id_column . ' IS NULL';
             } else {
-                $sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) );
+                if ( 'LIKE' === $meta_compare_key ) {
+                    $sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key LIKE %s", '%' . $wpdb->esc_like( trim( $clause['key'] ) ) . '%' );
+                } else {
+                    $sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) );
+                }
             }
         }