Changeset 59899 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Timestamp:

03/02/2025 10:05:08 PM (3 months ago)

Author:

TimothyBlynJacobs

Message:

REST API: Improve performance for HEAD requests.

By default, the REST API responds to HEAD rqeuests by calling the GET handler and omitting the body from the response. While convenient, this ends up performing needless work that slows down the API response time.

This commit adjusts the Core controllers to specifically handle HEAD requests by not preparing the response body.

Fixes #56481.
Props antonvlasenko, janusdev, ironprogrammer, swissspidy, spacedmonkey, mukesh27, mamaduka, timothyblynjacobs.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php (modified) (3 diffs)

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

@@ -356 +356 @@
             $prepared_args['search'] = '*' . $prepared_args['search'] . '*';
         }
+
+        $is_head_request = $request->is_method( 'HEAD' );
+        if ( $is_head_request ) {
+            // Force the 'fields' argument. For HEAD requests, only user IDs are required.
+            $prepared_args['fields'] = 'id';
+        }
         /**
          * Filters WP_User_Query arguments when querying users via the REST API.
@@ -370 +376 @@
         $query = new WP_User_Query( $prepared_args );
 
-        $users = array();
-
-        foreach ( $query->get_results() as $user ) {
-            $data    = $this->prepare_item_for_response( $user, $request );
-            $users[] = $this->prepare_response_for_collection( $data );
-        }
-
-        $response = rest_ensure_response( $users );
+        if ( ! $is_head_request ) {
+            $users = array();
+
+            foreach ( $query->get_results() as $user ) {
+                $data    = $this->prepare_item_for_response( $user, $request );
+                $users[] = $this->prepare_response_for_collection( $data );
+            }
+        }
+
+        $response = $is_head_request ? new WP_REST_Response() : rest_ensure_response( $users );
 
         // Store pagination values for headers then unset for count query.
@@ -1021 +1029 @@
         // Restores the more descriptive, specific name for use within this method.
         $user = $item;
+
+        // Don't prepare the response body for HEAD requests.
+        if ( $request->is_method( 'HEAD' ) ) {
+            /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php */
+            return apply_filters( 'rest_prepare_user', new WP_REST_Response(), $user, $request );
+        }
 
         $fields = $this->get_fields_for_response( $request );