<!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>[34934] trunk: Allow excluded keywords when searching posts.</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/34934">34934</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/34934","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>2015-10-08 03:17:22 +0000 (Thu, 08 Oct 2015)</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 excluded keywords when searching posts.
Pass a keyword with a leading hyphen to exclude posts containing that keyword.
For example, 'taco -onions' will return posts that contain the word 'taco' but
do not contain the word 'onions'.
Props akibjorklund.
Fixes <a href="https://core.trac.wordpress.org/ticket/33988">#33988</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesqueryphp">trunk/src/wp-includes/query.php</a></li>
<li><a href="#trunktestsphpunittestsquerysearchphp">trunk/tests/phpunit/tests/query/search.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesqueryphp"></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/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/query.php 2015-10-08 03:11:59 UTC (rev 34933)
+++ trunk/src/wp-includes/query.php 2015-10-08 03:17:22 UTC (rev 34934)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1509,7 +1509,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.2.0 Introduced the ability to order by specific clauses of a `$meta_query`, by passing the clause's
</span><span class="cx" style="display: block; padding: 0 10px"> * array key to `$orderby`.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 4.4.0 Introduced `$post_name__in` and `$title` parameters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Introduced `$post_name__in` and `$title` parameters. `$s` was updated to support excluded
+ * search terms, by prepending a hyphen.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><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="lines" style="display: block; padding: 0 10px; color: #888">@@ -1587,7 +1588,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $posts_per_archive_page The number of posts to query for by archive page. Overrides
</span><span class="cx" style="display: block; padding: 0 10px"> * 'posts_per_page' when is_archive(), or is_search() are true.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $post_name__in An array of post slugs that results must match.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $s Search keyword.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $s Search keyword(s). Prepending a term with a hyphen will
+ * exclude posts matching that term. Eg, 'pillow -sofa' will
+ * return posts containing 'pillow' but not 'sofa'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type int $second Second of the minute. Default empty. Accepts numbers 0-60.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $sentence Whether to search by phrase. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $suppress_filters Whether to suppress filters. Default false.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2158,13 +2161,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $searchand = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $q['search_orderby_title'] = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $q['search_terms'] as $term ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $n ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Terms prefixed with '-' should be excluded.
+ $include = '-' !== substr( $term, 0, 1 );
+ if ( $include ) {
+ $like_op = 'LIKE';
+ $andor_op = 'OR';
+ } else {
+ $like_op = 'NOT LIKE';
+ $andor_op = 'AND';
+ $term = substr( $term, 1 );
+ }
+
+ if ( $n && $include ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $like = '%' . $wpdb->esc_like( $term ) . '%';
</span><span class="cx" style="display: block; padding: 0 10px"> $q['search_orderby_title'][] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $like );
</span><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"> $like = $n . $wpdb->esc_like( $term ) . $n;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $search .= $wpdb->prepare( "{$searchand}(($wpdb->posts.post_title LIKE %s) OR ($wpdb->posts.post_content LIKE %s))", $like, $like );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $search .= $wpdb->prepare( "{$searchand}(($wpdb->posts.post_title $like_op %s) $andor_op ($wpdb->posts.post_content $like_op %s))", $like, $like );
</ins><span class="cx" style="display: block; padding: 0 10px"> $searchand = ' AND ';
</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">@@ -2264,11 +2278,19 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $q['search_terms_count'] > 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $num_terms = count( $q['search_orderby_title'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $like = '%' . $wpdb->esc_like( $q['s'] ) . '%';
</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 the search terms contain negative queries, don't bother ordering by sentence matches.
+ $like = '';
+ if ( ! preg_match( '/(?:\s|^)\-/', $q['s'] ) ) {
+ $like = '%' . $wpdb->esc_like( $q['s'] ) . '%';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $search_orderby = '(CASE ';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // sentence match in 'post_title'
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_title LIKE %s THEN 1 ", $like );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $like ) {
+ $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_title LIKE %s THEN 1 ", $like );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // sanity limit, sort as sentence when more than 6 terms
</span><span class="cx" style="display: block; padding: 0 10px"> // (few searches are longer than 6 terms and most titles are not)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2281,7 +2303,9 @@
</span><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"> // sentence match in 'post_content'
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 4 ", $like );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $like ) {
+ $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 4 ", $like );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $search_orderby .= 'ELSE 5 END)';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // single word or sentence search
</span></span></pre></div>
<a id="trunktestsphpunittestsquerysearchphp"></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/search.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/search.php 2015-10-08 03:11:59 UTC (rev 34933)
+++ trunk/tests/phpunit/tests/query/search.php 2015-10-08 03:17:22 UTC (rev 34934)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -58,4 +58,71 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function filter_wp_search_stopwords() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array();
</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 33988
+ */
+ public function test_s_should_exclude_term_prefixed_with_dash() {
+ $p1 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has foo but also bar',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has only foo',
+ ) );
+
+ $q = new WP_Query( array(
+ 's' => 'foo -bar',
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEqualSets( array( $p2 ), $q->posts );
+ }
+
+ /**
+ * @ticket 33988
+ */
+ public function test_s_should_exclude_first_term_if_prefixed_with_dash() {
+ $p1 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has foo but also bar',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has only bar',
+ ) );
+
+ $q = new WP_Query( array(
+ 's' => '-foo bar',
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEqualSets( array( $p2 ), $q->posts );
+ }
+
+ /**
+ * @ticket 33988
+ */
+ public function test_s_should_not_exclude_for_dashes_in_the_middle_of_words() {
+ $p1 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has foo but also bar',
+ ) );
+ $p2 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has only bar',
+ ) );
+ $p3 = $this->factory->post->create( array(
+ 'post_status' => 'publish',
+ 'post_content' => 'This post has only foo-bar',
+ ) );
+
+ $q = new WP_Query( array(
+ 's' => 'foo-bar',
+ 'fields' => 'ids',
+ ) );
+
+ $this->assertEqualSets( array( $p3 ), $q->posts );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>