Changeset 59970 for trunk/tests/phpunit/tests/rest-api/rest-sidebars-controller.php

Timestamp:

03/11/2025 02:17:41 PM (12 months ago)

Author:

TimothyBlynJacobs

Message:

REST API: Fix fatal error when making HEAD requests with _fields filter.

In [59889] the REST API controllers were adjusted to perform less work when responding to HEAD requests. The WP_REST_Response body would now be null, which caused issues with filters that expected the response body to be an array.

This commit sets the response body to be an empty array when preparing the response instead. The body will still be discarded, but this provides better backward comppatibility with code that assumes an array will be used.

See #56481.
Props antonvlasenko, timothyblynjacobs, mamaduka, wildworks.

File:

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

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

@@ -172 +172 @@
         $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
         $this->assertSame( 0, $filter->get_call_count(), 'The "' . $hook_name . '" filter was called when it should not be for HEAD requests.' );
-        $this->assertNull( $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+        $this->assertSame( array(), $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
     }
 
@@ -568 +568 @@
             return null;
         }
-        $this->assertNull( $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+        $this->assertSame( array(), $response->get_data(), 'The server should not generate a body in response to a HEAD request.' );
+    }
+
+    /**
+     * @dataProvider data_head_request_with_specified_fields_returns_success_response
+     * @ticket 56481
+     *
+     * @param string $path The path to test.
+     */
+    public function test_head_request_with_specified_fields_returns_success_response( $path ) {
+        $this->setup_sidebar(
+            'sidebar-1',
+            array(
+                'name' => 'Test sidebar',
+            )
+        );
+
+        $request = new WP_REST_Request( 'HEAD', $path );
+        // This endpoint doesn't seem to support _fields param, but we need to set it to reproduce the fatal error.
+        $request->set_param( '_fields', 'name' );
+        $server   = rest_get_server();
+        $response = $server->dispatch( $request );
+        add_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10, 3 );
+        $response = apply_filters( 'rest_post_dispatch', $response, $server, $request );
+        remove_filter( 'rest_post_dispatch', 'rest_filter_response_fields', 10 );
+
+        $this->assertSame( 200, $response->get_status(), 'The response status should be 200.' );
+    }
+
+    /**
+     * Data provider intended to provide paths for testing HEAD requests.
+     *
+     * @return array
+     */
+    public static function data_head_request_with_specified_fields_returns_success_response() {
+        return array(
+
+            'get_item request'  => array( '/wp/v2/sidebars/sidebar-1' ),
+            'get_items request' => array( '/wp/v2/sidebars' ),
+        );
     }