Changeset 59970 for trunk/tests/phpunit/tests/rest-api/rest-users-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-users-controller.php (modified) (4 diffs)

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

@@ -255 +255 @@
 
         if ( 'HEAD' === $method ) {
-            $this->assertNull( $response->get_data(), 'Expected null response data for HEAD request, but received non-null data.' );
+            $this->assertSame( array(), $response->get_data(), 'Expected null response data for HEAD request, but received non-null data.' );
             return null;
         }
@@ -3252 +3252 @@
             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.' );
     }
 
@@ -3273 +3273 @@
         $this->assertSame( 200, $response->get_status() );
         if ( $is_head_request ) {
-            $this->assertNull( $response->get_data() );
+            $this->assertSame( array(), $response->get_data() );
         } else {
             $this->assertNotEmpty( $response->get_data() );
@@ -3305 +3305 @@
         // Assert that the SQL query only fetches the id column.
         $this->assertMatchesRegularExpression( $pattern, $query->request, 'The SQL query does not match the expected string.' );
+    }
+
+    /**
+     * @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 ) {
+        $user_id = self::factory()->user->create();
+        wp_set_current_user( self::$user );
+
+        $request = new WP_REST_Request( 'HEAD', sprintf( $path, $user_id ) );
+        $request->set_param( '_fields', 'id' );
+        $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/users/%d' ),
+            'get_items request' => array( '/wp/v2/users' ),
+        );
     }