Changeset 59899 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-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-comments-controller.php (modified) (4 diffs)

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

@@ -263 +263 @@
         }
 
+        $is_head_request = $request->is_method( 'HEAD' );
+        if ( $is_head_request ) {
+            // Force the 'fields' argument. For HEAD requests, only post IDs are required to calculate pagination.
+            $prepared_args['fields'] = 'ids';
+            // Disable priming comment meta for HEAD requests to improve performance.
+            $prepared_args['update_comment_meta_cache'] = false;
+        }
+
         /**
          * Filters WP_Comment_Query arguments when querying comments via the REST API.
@@ -278 +286 @@
         $query_result = $query->query( $prepared_args );
 
-        $comments = array();
-
-        foreach ( $query_result as $comment ) {
-            if ( ! $this->check_read_permission( $comment, $request ) ) {
-                continue;
-            }
-
-            $data       = $this->prepare_item_for_response( $comment, $request );
-            $comments[] = $this->prepare_response_for_collection( $data );
+        if ( ! $is_head_request ) {
+            $comments = array();
+
+            foreach ( $query_result as $comment ) {
+                if ( ! $this->check_read_permission( $comment, $request ) ) {
+                    continue;
+                }
+
+                $data       = $this->prepare_item_for_response( $comment, $request );
+                $comments[] = $this->prepare_response_for_collection( $data );
+            }
         }
 
@@ -304 +314 @@
         }
 
-        $response = rest_ensure_response( $comments );
+        $response = $is_head_request ? new WP_REST_Response() : rest_ensure_response( $comments );
         $response->header( 'X-WP-Total', $total_comments );
         $response->header( 'X-WP-TotalPages', $max_pages );
@@ -1041 +1051 @@
         // Restores the more descriptive, specific name for use within this method.
         $comment = $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-comments-controller.php */
+            return apply_filters( 'rest_prepare_comment', new WP_REST_Response(), $comment, $request );
+        }
 
         $fields = $this->get_fields_for_response( $request );