Changeset 38792

Timestamp:

10/14/2016 08:05:40 PM (10 years ago)

Author:

boonebgorges

Message:

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 #38099.

Location:

trunk

Files:

• src/wp-includes/class-wp-query.php (modified) (2 diffs)
• tests/phpunit/tests/query/search.php (modified) (1 diff)

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

@@ -722 +722 @@
          *     @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'.
+         *                                                 return posts containing 'pillow' but not 'sofa'. This feature
+         *                                                 can be disabled using the
+         *                                                 'wp_query_use_hyphen_for_exclusion' filter.
          *     @type int          $second                  Second of the minute. Default empty. Accepts numbers 0-60.
          *     @type bool         $sentence                Whether to search by phrase. Default false.
@@ -1319 +1321 @@
                 $searchand = '';
                 $q['search_orderby_title'] = array();
+
+                /**
+                 * 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 );
+
                 foreach ( $q['search_terms'] as $term ) {
                         // Terms prefixed with '-' should be excluded.
                         $include = '-' !== substr( $term, 0, 1 );
-                        if ( $include ) {
+                        if ( $include || ! $hyphen_exclusion ) {
                                 $like_op  = 'LIKE';
                                 $andor_op = 'OR';

trunk/tests/phpunit/tests/query/search.php

@@ -58 +58 @@
         function filter_wp_search_stopwords() {
                 return array();
+        }
+
+        /**
+         * @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' );
         }