<!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>[37735] trunk: Multisite: Add search column support to `WP_Site_Query`.</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/37735">37735</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/37735","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-16 23:08:30 +0000 (Thu, 16 Jun 2016)</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'>Multisite: Add search column support to `WP_Site_Query`.
`domain` and/or `path` can be used to specify which column(s) should be searched.
See <a href="https://core.trac.wordpress.org/ticket/35791">#35791</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpsitequeryphp">trunk/src/wp-includes/class-wp-site-query.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitesiteQueryphp">trunk/tests/phpunit/tests/multisite/siteQuery.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpsitequeryphp"></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-site-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-site-query.php 2016-06-16 21:50:39 UTC (rev 37734)
+++ trunk/src/wp-includes/class-wp-site-query.php 2016-06-16 23:08:30 UTC (rev 37735)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,6 +141,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $spam Limit results to spam sites. Accepts '1' or '0'. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $deleted Limit results to deleted sites. Accepts '1' or '0'. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $search Search term(s) to retrieve matching sites for. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $search_columns Array of column names to be searched. Accepts 'domain' and 'path'.
+ * Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type bool $update_site_cache Whether to prime the cache for found sites. Default false.
</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">@@ -170,6 +172,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'spam' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'deleted' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> 'search' => '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'search_columns' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'count' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query' => null, // See WP_Date_Query
</span><span class="cx" style="display: block; padding: 0 10px"> 'update_site_cache' => true,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -481,10 +484,30 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Falsey search strings are ignored.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( strlen( $this->query_vars['search'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->sql_clauses['where']['search'] = $this->get_search_sql(
- $this->query_vars['search'],
- array( 'domain', 'path' )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $search_columns = array();
+
+ if ( $this->query_vars['search_columns'] ) {
+ $search_columns = array_intersect( $this->query_vars['search_columns'], array( 'domain', 'path' ) );
+ }
+
+ if ( ! $search_columns ) {
+ $search_columns = array( 'domain', 'path' );
+ }
+
+ /**
+ * Filters the columns to search in a WP_Site_Query search.
+ *
+ * The default columns include 'domain' and 'path.
+ *
+ * @since 4.6.0
+ *
+ * @param array $search_columns Array of column names to be searched.
+ * @param string $search Text being searched.
+ * @param WP_Site_Query $this The current WP_Site_Query instance.
+ */
+ $search_columns = apply_filters( 'site_search_columns', $search_columns, $this->query_vars['search'], $this );
+
+ $this->sql_clauses['where']['search'] = $this->get_search_sql( $this->query_vars['search'], $search_columns );
</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"> $date_query = $this->query_vars['date_query'];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -563,7 +586,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_search_sql( $string, $columns ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $like = '%' . $wpdb->esc_like( $string ) . '%';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false !== strpos( $string, '*' ) ) {
+ $like = '%' . implode( '%', array_map( array( $wpdb, 'esc_like' ), explode( '*', $string ) ) ) . '%';
+ } else {
+ $like = '%' . $wpdb->esc_like( $string ) . '%';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $searches = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $columns as $column ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsmultisitesiteQueryphp"></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/multisite/siteQuery.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/siteQuery.php 2016-06-16 21:50:39 UTC (rev 37734)
+++ trunk/tests/phpunit/tests/multisite/siteQuery.php 2016-06-16 23:08:30 UTC (rev 37735)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -470,6 +470,84 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, $found );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ public function test_wp_site_query_by_search_with_text_in_path_exclude_domain_from_search() {
+ $q = new WP_Site_Query();
+ $found = $q->query( array(
+ 'fields' => 'ids',
+ 'search' => 'make',
+ 'search_columns' => array( 'path' ),
+ ) );
+
+ $expected = array(
+ self::$site_ids['www.w.org/make/'],
+ );
+
+ $this->assertEquals( $expected, $found );
+ }
+
+ public function test_wp_site_query_by_search_with_text_in_domain_exclude_path_from_search() {
+ $q = new WP_Site_Query();
+ $found = $q->query( array(
+ 'fields' => 'ids',
+ 'search' => 'make',
+ 'search_columns' => array( 'domain' ),
+ ) );
+
+ $expected = array(
+ self::$site_ids['make.wordpress.org/'],
+ self::$site_ids['make.wordpress.org/foo/'],
+ );
+
+ $this->assertEquals( $expected, $found );
+ }
+
+ public function test_wp_site_query_by_search_with_wildcard_in_text() {
+ $q = new WP_Site_Query();
+ $found = $q->query( array(
+ 'fields' => 'ids',
+ 'search' => 'm*ke',
+ ) );
+
+ $expected = array(
+ self::$site_ids['www.w.org/make/'],
+ self::$site_ids['make.wordpress.org/'],
+ self::$site_ids['make.wordpress.org/foo/'],
+ );
+
+ $this->assertEqualSets( $expected, $found );
+ }
+
+ public function test_wp_site_query_by_search_with_wildcard_in_text_exclude_path_from_search() {
+ $q = new WP_Site_Query();
+ $found = $q->query( array(
+ 'fields' => 'ids',
+ 'search' => 'm*ke',
+ 'search_columns' => array( 'domain' ),
+ ) );
+
+ $expected = array(
+ self::$site_ids['make.wordpress.org/'],
+ self::$site_ids['make.wordpress.org/foo/'],
+ );
+
+ $this->assertEqualSets( $expected, $found );
+ }
+
+ public function test_wp_site_query_by_search_with_wildcard_in_text_exclude_domain_from_search() {
+ $q = new WP_Site_Query();
+ $found = $q->query( array(
+ 'fields' => 'ids',
+ 'search' => 'm*ke',
+ 'search_columns' => array( 'path' ),
+ ) );
+
+ $expected = array(
+ self::$site_ids['www.w.org/make/'],
+ );
+
+ $this->assertEqualSets( $expected, $found );
+ }
</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"> endif;
</span></span></pre>
</div>
</div>
</body>
</html>