<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[42768] trunk: Allow `LIKE` queries against the 'key' value in meta queries.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/42768">42768</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42768","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-03-01 04:02:41 +0000 (Thu, 01 Mar 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/42409">#42409</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpmetaqueryphp">trunk/src/wp-includes/class-wp-meta-query.php</a></li>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-query.php</a></li>
<li><a href="#trunktestsphpunittestsquerymetaQueryphp">trunk/tests/phpunit/tests/query/metaQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpmetaqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-meta-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-meta-query.php 2018-02-28 22:36:00 UTC (rev 42767)
+++ trunk/src/wp-includes/class-wp-meta-query.php 2018-03-01 04:02:41 UTC (rev 42768)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,6 +99,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.0.0 Introduced $compare_key clause parameter, which enables LIKE key matches.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $meta_query {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of meta query clauses. When first-order clauses or sub-clauses use strings as
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,17 +110,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. An array of first-order clause parameters, or another fully-formed meta query.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @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'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,7 +239,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the rest of the meta_query).
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $primary_meta_query = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array( 'key', 'compare', 'type' ) as $key ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'key', 'compare', 'type', 'compare_key' ) as $key ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $qv[ "meta_$key" ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $primary_meta_query[ $key ] = $qv[ "meta_$key" ];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -518,8 +521,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $clause['compare'] = '=';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $meta_compare = $clause['compare'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $clause['compare_key'] ) && 'LIKE' === strtoupper( $clause['compare_key'] ) ) {
+ $clause['compare_key'] = strtoupper( $clause['compare_key'] );
+ } else {
+ $clause['compare_key'] = '=';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $meta_compare = $clause['compare'];
+ $meta_compare_key = $clause['compare_key'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // First build the JOIN clause, if one is required.
</span><span class="cx" style="display: block; padding: 0 10px"> $join = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -533,8 +543,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'NOT EXISTS' === $meta_compare ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $join .= " LEFT JOIN $this->meta_table";
</span><span class="cx" style="display: block; padding: 0 10px"> $join .= $i ? " AS $alias" : '';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // All other JOIN clauses.
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $join .= " INNER JOIN $this->meta_table";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -577,7 +592,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'NOT EXISTS' === $meta_compare ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sql_chunks['where'][] = $alias . '.' . $this->meta_id_column . ' IS NULL';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpqueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-query.php 2018-02-28 22:36:00 UTC (rev 42767)
+++ trunk/src/wp-includes/class-wp-query.php 2018-03-01 04:02:41 UTC (rev 42768)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -604,6 +604,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Introduced `RAND(x)` syntax for `$orderby`, which allows an integer seed value to random sorts.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0 Added 'post_name__in' support for `$orderby`. Introduced the `$lazy_load_term_meta` argument.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.0 Introduced the `$comment_count` parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.0.0 Introduced the `$meta_compare_key` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $query {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array or string of Query parameters.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -640,6 +641,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $m Combination YearMonth. Accepts any four-digit year and month
</span><span class="cx" style="display: block; padding: 0 10px"> * numbers 1-12. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $meta_compare Comparison operator to test the 'meta_value'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $meta_compare_key Comparison operator to test the 'meta_key'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $meta_key Custom field key.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $meta_query An associative array of WP_Meta_Query arguments. See WP_Meta_Query.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $meta_value Custom field value.
</span></span></pre></div>
<a id="trunktestsphpunittestsquerymetaQueryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/query/metaQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/metaQuery.php 2018-02-28 22:36:00 UTC (rev 42767)
+++ trunk/tests/phpunit/tests/query/metaQuery.php 2018-03-01 04:02:41 UTC (rev 42768)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1848,4 +1848,78 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEqualSets( array( 'foo_key', 'foo_key-1', 'foo_key-2' ), array_keys( $q->meta_query->get_clauses() ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 42409
+ */
+ public function test_compare_key_like() {
+ $posts = self::factory()->post->create_many( 3 );
+
+ add_post_meta( $posts[0], 'aaa_foo_aaa', 'abc' );
+ add_post_meta( $posts[1], 'aaa_bar_aaa', 'abc' );
+ add_post_meta( $posts[2], 'aaa_foo_bbb', 'abc' );
+
+ $q = new WP_Query(
+ array(
+ 'meta_query' => array(
+ array(
+ 'compare_key' => 'LIKE',
+ 'key' => 'aa_foo',
+ ),
+ ),
+ 'fields' => 'ids',
+ )
+ );
+
+ $this->assertEqualSets( array( $posts[0], $posts[2] ), $q->posts );
+ }
+
+ /**
+ * @ticket 42409
+ */
+ public function test_meta_compare_key_like() {
+ $posts = self::factory()->post->create_many( 3 );
+
+ add_post_meta( $posts[0], 'aaa_foo_aaa', 'abc' );
+ add_post_meta( $posts[1], 'aaa_bar_aaa', 'abc' );
+ add_post_meta( $posts[2], 'aaa_foo_bbb', 'abc' );
+
+ $q = new WP_Query(
+ array(
+ 'meta_compare_key' => 'LIKE',
+ 'meta_key' => 'aa_foo',
+ 'fields' => 'ids',
+ )
+ );
+
+ $this->assertEqualSets( array( $posts[0], $posts[2] ), $q->posts );
+ }
+
+ /**
+ * @ticket 42409
+ */
+ public function test_compare_key_like_with_not_exists_compare() {
+ $posts = self::factory()->post->create_many( 3 );
+
+ add_post_meta( $posts[0], 'aaa_foo_aaa', 'abc' );
+ add_post_meta( $posts[1], 'aaa_bar_aaa', 'abc' );
+ add_post_meta( $posts[2], 'bar', 'abc' );
+
+ $q = new WP_Query(
+ array(
+ 'meta_query' => array(
+ 'relation' => 'AND',
+ array(
+ 'compare_key' => 'LIKE',
+ 'key' => 'bar',
+ 'compare' => 'NOT EXISTS',
+ ),
+ ),
+ 'fields' => 'ids',
+ )
+ );
+
+ $this->assertEqualSets( array( $posts[0] ), $q->posts );
+
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>