Changeset 56819 for trunk/src/wp-includes/block-template-utils.php

Timestamp:

10/10/2023 02:03:03 PM (16 months ago)

Author:

spacedmonkey

Message:

REST API: Fix issue with Template and Template Part Revision/Autosave REST API controllers.

The Template and Template Part REST API controllers have unique characteristics compared to other post type REST API controllers. They do not rely on integer IDs to reference objects; instead, they use a combination of the theme name and slug of the template, like 'twentytwentyfourhome.' Consequently, when the post types template and template part were introduced in [52062], it led to the registration of REST API endpoints for autosaves and revisions with invalid URL structures.

In this commit, we introduce new functionality to enable custom autosave and revisions endpoints to be registered at the post type level. Similar to the 'rest_controller_class' parameter, developers can now define 'revisions_rest_controller' and 'autosave_rest_controller.' This empowers developers to create custom controllers for these functionalities. Additionally, we introduce a 'late_route_registration' parameter, which proves helpful when dealing with custom URL patterns and regex pattern matching issues.
This commit registers new classes for template and template part autosave and revisions controllers, differentiating them from standard controllers in the following ways:

• The response shape now matches that of the template controller.
• Permission checks align with the template controller.
• A custom URL pattern is introduced to support slug-based identification of templates.

Furthermore, we've updated the utility function '_build_block_template_result_from_post' to support passing revision post objects. This enhancement ensures compatibility with the custom revisions controller.

Props spacedmonkey, revgeorge, andraganescu, hellofromTonya, antonvlasenko, kadamwhite, ironprogrammer, costdev, mukesh27, timothyblynjacobs, adamsilverstein.
Fixes 56922.

File:

• trunk/src/wp-includes/block-template-utils.php (modified) (5 diffs)

trunk/src/wp-includes/block-template-utils.php

@@ -725 +725 @@
  * @since 5.9.0
  * @since 6.3.0 Added `modified` property to template objects.
+ * @since 6.4.0 Added support for a revision post to be passed to this function.
  * @access private
  *
@@ -732 +733 @@
 function _build_block_template_result_from_post( $post ) {
     $default_template_types = get_default_block_template_types();
-    $terms                  = get_the_terms( $post, 'wp_theme' );
+
+    $post_id = wp_is_post_revision( $post );
+    if ( ! $post_id ) {
+        $post_id = $post;
+    }
+    $parent_post = get_post( $post_id );
+
+    $terms = get_the_terms( $parent_post, 'wp_theme' );
 
     if ( is_wp_error( $terms ) ) {
@@ -746 +754 @@
     $has_theme_file = get_stylesheet() === $theme && null !== $template_file;
 
-    $origin           = get_post_meta( $post->ID, 'origin', true );
-    $is_wp_suggestion = get_post_meta( $post->ID, 'is_wp_suggestion', true );
+    $origin           = get_post_meta( $parent_post->ID, 'origin', true );
+    $is_wp_suggestion = get_post_meta( $parent_post->ID, 'is_wp_suggestion', true );
 
     $template                 = new WP_Block_Template();
     $template->wp_id          = $post->ID;
-    $template->id             = $theme . '//' . $post->post_name;
+    $template->id             = $theme . '//' . $parent_post->post_name;
     $template->theme          = $theme;
     $template->content        = $post->post_content;
@@ -766 +774 @@
     $template->modified       = $post->post_modified;
 
-    if ( 'wp_template' === $post->post_type && $has_theme_file && isset( $template_file['postTypes'] ) ) {
+    if ( 'wp_template' === $parent_post->post_type && $has_theme_file && isset( $template_file['postTypes'] ) ) {
         $template->post_types = $template_file['postTypes'];
     }
 
-    if ( 'wp_template' === $post->post_type && isset( $default_template_types[ $template->slug ] ) ) {
+    if ( 'wp_template' === $parent_post->post_type && isset( $default_template_types[ $template->slug ] ) ) {
         $template->is_custom = false;
     }
 
-    if ( 'wp_template_part' === $post->post_type ) {
-        $type_terms = get_the_terms( $post, 'wp_template_part_area' );
+    if ( 'wp_template_part' === $parent_post->post_type ) {
+        $type_terms = get_the_terms( $parent_post, 'wp_template_part_area' );
         if ( ! is_wp_error( $type_terms ) && false !== $type_terms ) {
             $template->area = $type_terms[0]->name;
@@ -782 +790 @@
 
     // Check for a block template without a description and title or with a title equal to the slug.
-    if ( 'wp_template' === $post->post_type && empty( $template->description ) && ( empty( $template->title ) || $template->title === $template->slug ) ) {
+    if ( 'wp_template' === $parent_post->post_type && empty( $template->description ) && ( empty( $template->title ) || $template->title === $template->slug ) ) {
         $matches = array();