Changeset 58080

Timestamp:

05/02/2024 04:27:32 PM (5 months ago)

Author:

jorbin

Message:

REST API: Return empty object when no fallback templates are found (wp/v2/templates/lookup)

This prevents a number of php notices that are surfaced due to the endpoint being called on load of the post editor even when there are no templates.

Reviewed by joemcgill.
Merges [58079] to the 6.5 branch.

Props grantmkin, CookiesForDevo, britner, wildworks, jorbin.
Fixes #60909.

Location:

branches/6.5

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/wpRestTemplatesController.php (modified) (1 diff)

branches/6.5/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

@@ -166 +166 @@
         } while ( ! empty( $hierarchy ) && empty( $fallback_template->content ) );
 
-        $response = $this->prepare_item_for_response( $fallback_template, $request );
+        // To maintain original behavior, return an empty object rather than a 404 error when no template is found.
+        $response = $fallback_template ? $this->prepare_item_for_response( $fallback_template, $request ) : new stdClass();
 
         return rest_ensure_response( $response );

branches/6.5/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

@@ -911 +911 @@
 
     /**
+     * @ticket 60909
+     * @covers WP_REST_Templates_Controller::get_template_fallback
+     */
+    public function test_get_template_fallback_not_found() {
+        wp_set_current_user( self::$admin_id );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/templates/lookup' );
+        $request->set_param( 'slug', 'not-found' );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $this->assertEquals( new stdClass(), $data, 'Response should be an empty object when a fallback template is not found.' );
+    }
+
+    /**
      * @ticket 57851
      *