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

Timestamp:

09/30/2024 01:17:40 AM (2 months ago)

Author:

peterwilsoncc

Message:

REST API/Editor: Support post formats in Query Block & Posts API.

Introduces post format support for both the Query Block with the new parameter format. In the build_query_vars_from_query_block() function, this is converted to a post_format taxonomy query passed to WP_Query.

Also introduces the format parameter to the REST API's Posts controller to support the feature in the Query block. The parameter type is an enumerated string accepted the post formats supported by each post type.

Props poena, mukesh27, mamaduka, noisysocks, TimothyBlynJacobs.
Fixes #62014.

File:

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

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

@@ -197 +197 @@
                 'context',
                 'exclude',
+                'format',
                 'include',
                 'modified_after',
@@ -5498 +5499 @@
 
     /**
+     * Test the REST API support for the standard post format.
+     *
+     * @ticket 62014
+     *
+     * @covers WP_REST_Posts_Controller::get_items
+     */
+    public function test_standard_post_format_support() {
+        $initial_theme_support = get_theme_support( 'post-formats' );
+        add_theme_support( 'post-formats', array( 'aside', 'gallery', 'link', 'image', 'quote', 'status', 'video', 'audio', 'chat' ) );
+
+        $post_id = self::factory()->post->create(
+            array(
+                'post_type'   => 'post',
+                'post_status' => 'publish',
+            )
+        );
+        set_post_format( $post_id, 'aside' );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'format', array( 'standard' ) );
+        $request->set_param( 'per_page', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+
+        $response = rest_get_server()->dispatch( $request );
+
+        /*
+         * Restore the initial post formats support.
+         *
+         * This needs to be done prior to the assertions to avoid unexpected
+         * results for other tests should an assertion fail.
+         */
+        if ( $initial_theme_support ) {
+            add_theme_support( 'post-formats', $initial_theme_support[0] );
+        } else {
+            remove_theme_support( 'post-formats' );
+        }
+
+        $this->assertCount( 3, $response->get_data(), 'The response should only include standard post formats' );
+    }
+
+    /**
+     * Test the REST API support for post formats.
+     *
+     * @ticket 62014
+     *
+     * @covers WP_REST_Posts_Controller::get_items
+     */
+    public function test_post_format_support() {
+        $initial_theme_support = get_theme_support( 'post-formats' );
+        add_theme_support( 'post-formats', array( 'aside', 'gallery', 'link', 'image', 'quote', 'status', 'video', 'audio', 'chat' ) );
+
+        $post_id = self::factory()->post->create(
+            array(
+                'post_type'   => 'post',
+                'post_status' => 'publish',
+            )
+        );
+        set_post_format( $post_id, 'aside' );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'format', array( 'aside' ) );
+
+        $response_aside = rest_get_server()->dispatch( $request );
+
+        $request->set_param( 'format', array( 'invalid_format' ) );
+        $response_invalid = rest_get_server()->dispatch( $request );
+
+        /*
+         * Restore the initial post formats support.
+         *
+         * This needs to be done prior to the assertions to avoid unexpected
+         * results for other tests should an assertion fail.
+         */
+        if ( $initial_theme_support ) {
+            add_theme_support( 'post-formats', $initial_theme_support[0] );
+        } else {
+            remove_theme_support( 'post-formats' );
+        }
+
+        $this->assertCount( 1, $response_aside->get_data(), 'Only one post is expected to be returned.' );
+        $this->assertErrorResponse( 'rest_invalid_param', $response_invalid, 400, 'An invalid post format should return an error' );
+    }
+
+    /**
+     * Test the REST API support for multiple post formats.
+     *
+     * @ticket 62014
+     *
+     * @covers WP_REST_Posts_Controller::get_items
+     */
+    public function test_multiple_post_format_support() {
+        $initial_theme_support = get_theme_support( 'post-formats' );
+        add_theme_support( 'post-formats', array( 'aside', 'gallery', 'link', 'image', 'quote', 'status', 'video', 'audio', 'chat' ) );
+
+        $post_id = self::factory()->post->create(
+            array(
+                'post_type'   => 'post',
+                'post_status' => 'publish',
+            )
+        );
+        set_post_format( $post_id, 'aside' );
+
+        $post_id_2 = self::factory()->post->create(
+            array(
+                'post_type'   => 'post',
+                'post_status' => 'publish',
+            )
+        );
+        set_post_format( $post_id_2, 'gallery' );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'format', array( 'aside', 'gallery' ) );
+
+        $response = rest_get_server()->dispatch( $request );
+
+        /*
+         * Restore the initial post formats support.
+         *
+         * This needs to be done prior to the assertions to avoid unexpected
+         * results for other tests should an assertion fail.
+         */
+        if ( $initial_theme_support ) {
+            add_theme_support( 'post-formats', $initial_theme_support[0] );
+        } else {
+            remove_theme_support( 'post-formats' );
+        }
+
+        $this->assertCount( 2, $response->get_data(), 'Two posts are expected to be returned' );
+    }
+
+    /**
      * Internal function used to disable an insert query which
      * will trigger a wpdb error for testing purposes.