Changeset 49132

Timestamp:

10/12/2020 07:52:57 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Introduce search post format handler.
This allows for clients to search the used post formats via the /wp/v2/search endpoint by using a type=post-format query parameter.
Fixes #51459.
Props andraganescu, zieladam, noisysocks, TimothyBlynJacobs.

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• src/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php (added)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-search-controller.php (modified) (4 diffs)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -277 +277 @@
         new WP_REST_Post_Search_Handler(),
         new WP_REST_Term_Search_Handler(),
+        new WP_REST_Post_Format_Search_Handler(),
     );
 

trunk/src/wp-settings.php

@@ -270 +270 @@
 require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-post-search-handler.php';
 require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-term-search-handler.php';
+require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-post-format-search-handler.php';
 require ABSPATH . WPINC . '/sitemaps.php';
 require ABSPATH . WPINC . '/sitemaps/class-wp-sitemaps.php';

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

@@ -55 +55 @@
      */
     public static function wpSetUpBeforeClass( $factory ) {
+        add_theme_support( 'post-formats' );
+
         self::$my_title_post_ids = $factory->post->create_many(
             4,
@@ -78 +80 @@
         );
 
+        set_post_format( self::$my_title_post_ids[0], 'aside' );
+
         self::$my_category_id = $factory->term->create(
             array(
@@ -97 +101 @@
      */
     public static function wpTearDownAfterClass() {
+        remove_theme_support( 'post-formats' );
+
         $post_ids = array_merge(
             self::$my_title_post_ids,
@@ -705 +711 @@
 
     /**
+     * Search through post formats of any type.
+     *
+     * @ticket 51459
+     */
+    public function test_get_items_search_type_post_format() {
+        $response = $this->do_request_with_params(
+            array(
+                'per_page' => 100,
+                'type'     => 'post-format',
+            )
+        );
+        $this->assertEquals( 200, $response->get_status() );
+        $this->assertContains(
+            'Aside',
+            wp_list_pluck( $response->get_data(), 'title' )
+        );
+    }
+
+    /**
+     * Search through all that matches a 'Aside' search.
+     *
+     * @ticket 51459
+     */
+    public function test_get_items_search_for_test_post_format() {
+        $response = $this->do_request_with_params(
+            array(
+                'per_page' => 100,
+                'search'   => 'Aside',
+                'type'     => 'post-format',
+            )
+        );
+
+        $this->assertEquals( 200, $response->get_status() );
+        $this->assertContains(
+            'Aside',
+            wp_list_pluck( $response->get_data(), 'title' )
+        );
+    }
+
+    /**
+     * Searching for a post format that doesn't exist should return an empty
+     * result.
+     *
+     * @ticket 51459
+     */
+    public function test_get_items_search_for_missing_post_format() {
+        $response = $this->do_request_with_params(
+            array(
+                'per_page' => 100,
+                'search'   => 'Doesn\'t exist',
+                'type'     => 'post-format',
+            )
+        );
+
+        $this->assertEquals( 200, $response->get_status() );
+        $this->assertEmpty( $response->get_data() );
+    }
+
+    /**
      * Perform a REST request to our search endpoint with given parameters.
      */

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -4511 +4511 @@
                             "enum": [
                                 "post",
-                                "term"
+                                "term",
+                                "post-format"
                             ],
                             "description": "Limit results to items of an object type.",