Changeset 59544

Timestamp:

12/19/2024 09:41:19 PM (8 weeks ago)

Author:

peterwilsoncc

Message:

REST API: Protect against fatal error for post types without format support.

Ignore the format parameter introduced in WordPress 6.7 for post types that do not support post formats. This protects against a fatal error being thrown in later version of PHP or a warning in earlier versions of PHP.

Follow up to r59115.

Props dd32, sergeybiryukov, yogeshbhutkar.
Fixes #62646.
See #62014.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (8 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -347 +347 @@
         $args = $this->prepare_tax_query( $args, $request );
 
-        if ( ! empty( $request['format'] ) ) {
+        if ( isset( $registered['format'], $request['format'] ) ) {
             $formats = $request['format'];
             /*

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

@@ -5509 +5509 @@
 
     /**
-     * Test the REST API support for the standard post format.
+     * Test the REST API ignores the post format parameter for post types that do not support them.
      *
+     * @ticket 62646
      * @ticket 62014
      *
      * @covers WP_REST_Posts_Controller::get_items
      */
-    public function test_standard_post_format_support() {
+    public function test_standard_post_format_ignored_for_post_types_that_do_not_support_them() {
         $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',
+        self::factory()->post->create(
+            array(
+                'post_type'   => 'page',
                 '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 );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/pages' );
+        $request->set_param( 'format', 'invalid_type' );
 
         $response = rest_get_server()->dispatch( $request );
@@ -5545 +5544 @@
         }
 
-        $this->assertCount( 3, $response->get_data(), 'The response should only include standard post formats' );
-    }
-
-    /**
-     * Test the REST API support for post formats.
+        $this->assertCount( 1, $response->get_data(), 'The response should ignore the post format parameter' );
+    }
+
+    /**
+     * Test the REST API support for the standard post format.
      *
      * @ticket 62014
@@ -5555 +5554 @@
      * @covers WP_REST_Posts_Controller::get_items
      */
-    public function test_post_format_support() {
+    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' ) );
@@ -5568 +5567 @@
 
         $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 );
+        $request->set_param( 'format', array( 'standard' ) );
+        $request->set_param( 'per_page', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
+
+        $response = rest_get_server()->dispatch( $request );
 
         /*
@@ -5587 +5584 @@
         }
 
-        $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.
+        $this->assertCount( 3, $response->get_data(), 'The response should only include standard post formats' );
+    }
+
+    /**
+     * Test the REST API support for post formats.
      *
      * @ticket 62014
@@ -5598 +5594 @@
      * @covers WP_REST_Posts_Controller::get_items
      */
-    public function test_multiple_post_format_support() {
+    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' ) );
@@ -5610 +5606 @@
         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 );
+        $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 );
 
         /*
@@ -5635 +5626 @@
         }
 
+        $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' );
     }