Changeset 34934

Timestamp:

10/08/2015 03:17:22 AM (9 years ago)

Author:

boonebgorges

Message:

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

Location:

trunk

Files:

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

trunk/src/wp-includes/query.php

@@ -1510 +1510 @@
      * @since 4.2.0 Introduced the ability to order by specific clauses of a `$meta_query`, by passing the clause's
      *              array key to `$orderby`.
-     * @since 4.4.0 Introduced `$post_name__in` and `$title` parameters.
+     * @since 4.4.0 Introduced `$post_name__in` and `$title` parameters. `$s` was updated to support excluded
+     *              search terms, by prepending a hyphen.
      * @access public
      *
@@ -1588 +1589 @@
      *                                                 'posts_per_page' when is_archive(), or is_search() are true.
      *     @type array        $post_name__in           An array of post slugs that results must match.
-     *     @type string       $s                       Search keyword.
+     *     @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'.
      *     @type int          $second                  Second of the minute. Default empty. Accepts numbers 0-60.
      *     @type bool         $sentence                Whether to search by phrase. Default false.
@@ -2159 +2162 @@
         $q['search_orderby_title'] = array();
         foreach ( $q['search_terms'] as $term ) {
-            if ( $n ) {
+            // 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 ) {
                 $like = '%' . $wpdb->esc_like( $term ) . '%';
                 $q['search_orderby_title'][] = $wpdb->prepare( "$wpdb->posts.post_title LIKE %s", $like );
@@ -2165 +2179 @@
 
             $like = $n . $wpdb->esc_like( $term ) . $n;
-            $search .= $wpdb->prepare( "{$searchand}(($wpdb->posts.post_title LIKE %s) OR ($wpdb->posts.post_content LIKE %s))", $like, $like );
+            $search .= $wpdb->prepare( "{$searchand}(($wpdb->posts.post_title $like_op %s) $andor_op ($wpdb->posts.post_content $like_op %s))", $like, $like );
             $searchand = ' AND ';
         }
@@ -2265 +2279 @@
         if ( $q['search_terms_count'] > 1 ) {
             $num_terms = count( $q['search_orderby_title'] );
-            $like = '%' . $wpdb->esc_like( $q['s'] ) . '%';
+
+            // 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'] ) . '%';
+            }
 
             $search_orderby = '(CASE ';
+
             // sentence match in 'post_title'
-            $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_title LIKE %s THEN 1 ", $like );
+            if ( $like ) {
+                $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_title LIKE %s THEN 1 ", $like );
+            }
 
             // sanity limit, sort as sentence when more than 6 terms
@@ -2282 +2304 @@
 
             // sentence match in 'post_content'
-            $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 4 ", $like );
+            if ( $like ) {
+                $search_orderby .= $wpdb->prepare( "WHEN $wpdb->posts.post_content LIKE %s THEN 4 ", $like );
+            }
             $search_orderby .= 'ELSE 5 END)';
         } else {

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

@@ -59 +59 @@
         return array();
     }
+
+    /**
+     * @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 );
+    }
 }