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

Timestamp:

03/02/2025 10:05:08 PM (18 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-font-collections-controller.php (modified) (4 diffs)

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

@@ -90 +90 @@
                 $collections_page = array_slice( $collections_all, ( $page - 1 ) * $per_page, $per_page );
 
+                $is_head_request = $request->is_method( 'HEAD' );
+
                 $items = array();
                 foreach ( $collections_page as $collection ) {
@@ -98 +100 @@
                                 continue;
                         }
+
+                        /*
+                         * Skip preparing the response body for HEAD requests.
+                         * Cannot exit earlier due to backward compatibility reasons,
+                         * as validation occurs in the prepare_item_for_response method.
+                         */
+                        if ( $is_head_request ) {
+                                continue;
+                        }
+
                         $item    = $this->prepare_response_for_collection( $item );
                         $items[] = $item;
                 }
 
-                $response = rest_ensure_response( $items );
+                $response = $is_head_request ? new WP_REST_Response() : rest_ensure_response( $items );
 
                 $response->header( 'X-WP-Total', (int) $total_items );
@@ -176 +188 @@
                         }
 
+                        /**
+                         * Don't prepare the response body for HEAD requests.
+                         * Can't exit at the beginning of the method due to the potential need to return a WP_Error object.
+                         */
+                        if ( $request->is_method( 'HEAD' ) ) {
+                                /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php */
+                                return apply_filters( 'rest_prepare_font_collection', new WP_REST_Response(), $item, $request );
+                        }
+
                         foreach ( $data_fields as $field ) {
                                 if ( rest_is_field_included( $field, $fields ) ) {
@@ -181 +202 @@
                                 }
                         }
+                }
+
+                /**
+                 * Don't prepare the response body for HEAD requests.
+                 * Can't exit at the beginning of the method due to the potential need to return a WP_Error object.
+                 */
+                if ( $request->is_method( 'HEAD' ) ) {
+                        /** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-font-collections-controller.php */
+                        return apply_filters( 'rest_prepare_font_collection', new WP_REST_Response(), $item, $request );
                 }