<!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>[38792] trunk: Query: Allow the hyphen-prefix-for-search-exclusion feature to be disabled by filter.</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/38792">38792</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/38792","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>2016-10-14 20:05:40 +0000 (Fri, 14 Oct 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'>Query: Allow the hyphen-prefix-for-search-exclusion feature to be disabled by filter.
WordPress 4.4 introduced "hyphen exclusion" for search terms, so that
"foo -bar" would return posts containing "foo" AND not containing "bar".
The new filter 'wp_query_use_hyphen_for_exclusion' allows developers
to disable this feature when it's known that their content will contain
semantically important leading hyphens.
Props chriseverson, choongsavvii.
Fixes <a href="https://core.trac.wordpress.org/ticket/38099">#38099</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpqueryphp">trunk/src/wp-includes/class-wp-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="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 2016-10-14 19:38:17 UTC (rev 38791)
+++ trunk/src/wp-includes/class-wp-query.php 2016-10-14 20:05:40 UTC (rev 38792)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -721,7 +721,9 @@
</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><span class="cx" style="display: block; padding: 0 10px"> * @type string $s Search keyword(s). Prepending a term with a hyphen will
</span><span class="cx" style="display: block; padding: 0 10px"> * exclude posts matching that term. Eg, 'pillow -sofa' will
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * return posts containing 'pillow' but not 'sofa'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * return posts containing 'pillow' but not 'sofa'. This feature
+ * can be disabled using the
+ * 'wp_query_use_hyphen_for_exclusion' filter.
</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">@@ -1318,10 +1320,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $n = ! empty( $q['exact'] ) ? '' : '%';
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters whether search terms preceded by hyphens should excluded from results.
+ *
+ * @since 4.7.0
+ *
+ * @param bool Whether the query should exclude terms preceded with a hyphen.
+ */
+ $hyphen_exclusion = apply_filters( 'wp_query_use_hyphen_for_exclusion', true );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $q['search_terms'] as $term ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Terms prefixed with '-' should be excluded.
</span><span class="cx" style="display: block; padding: 0 10px"> $include = '-' !== substr( $term, 0, 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $include ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $include || ! $hyphen_exclusion ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $like_op = 'LIKE';
</span><span class="cx" style="display: block; padding: 0 10px"> $andor_op = 'OR';
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</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 2016-10-14 19:38:17 UTC (rev 38791)
+++ trunk/tests/phpunit/tests/query/search.php 2016-10-14 20:05:40 UTC (rev 38792)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,6 +60,28 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 38099
+ */
+ function test_filter_wp_query_use_hyphen_for_exclusion() {
+ $title = '-HYPHENATION_TEST';
+
+ // Create a post with a title which starts with a hyphen
+ $post_id = self::factory()->post->create( array(
+ 'post_content' => $title, 'post_type' => $this->post_type
+ ) );
+
+ // By default, we can use the hyphen prefix to exclude results
+ $this->assertEquals( array(), $this->get_search_results( $title ) );
+
+ // After we disable the feature using the filter, we should get the result
+ add_filter( 'wp_query_use_hyphen_for_exclusion', '__return_false' );
+ $result = $this->get_search_results( $title );
+ $post = array_pop( $result );
+ $this->assertEquals( $post->ID, $post_id );
+ remove_filter( 'wp_query_use_hyphen_for_exclusion', '__return_false' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 33988
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_s_should_exclude_term_prefixed_with_dash() {
</span></span></pre>
</div>
</div>
</body>
</html>