Changeset 55248 for trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

Timestamp:

02/07/2023 08:53:01 AM (4 years ago)

Author:

audrasjb

Message:

Query: Add a search_columns argument to control which fields are searched in a search query.

Previously, the s argument of the WP_Query::parse_query() method searched the post_title, post_excerpt, and post_content fields, with no way of controlling this apart from using the posts_search filter and adjusting the SQL manually. This changeset adds the ability to specify which fields are searched when performing a query, using the search_columns argument.

Props johnbillion, birgire, petitphp, audrasjb, costdev, mukesh27.
Fixes #43867.

File:

• trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (2 diffs)

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -205 +205 @@
                                 'per_page',
                                 'search',
+                                'search_columns',
                                 'slug',
                                 'status',
@@ -1526 +1527 @@
 
                 $this->assertPostsWhere( " AND {posts}.ID NOT IN ($id3) AND {posts}.post_type = 'post' AND (({posts}.post_status = 'publish'))" );
+        }
+
+        /**
+         * Tests that Rest Post controller supports search columns.
+         *
+         * @ticket 43867
+         * @covers WP_REST_Posts_Controller::get_items
+         */
+        public function test_get_items_with_custom_search_columns() {
+                $id1 = self::factory()->post->create(
+                        array(
+                                'post_title'   => 'Title contain foo and bar',
+                                'post_content' => 'Content contain bar',
+                                'post_excerpt' => 'Excerpt contain baz',
+                        )
+                );
+                $id2 = self::factory()->post->create(
+                        array(
+                                'post_title'   => 'Title contain baz',
+                                'post_content' => 'Content contain foo and bar',
+                                'post_excerpt' => 'Excerpt contain foo, bar and baz',
+                        )
+                );
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'search', 'foo bar' );
+                $request->set_param( 'search_columns', array( 'post_title' ) );
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertSame( 200, $response->get_status(), 'Response should have a status code 200.' );
+                $data = $response->get_data();
+                $this->assertCount( 1, $data, 'Response should contain one result.' );
+                $this->assertSame( $id1, $data[0]['id'], 'Result should match expected value.' );
         }