Changeset 51003

Timestamp:

05/25/2021 02:19:14 PM (3 years ago)

Author:

youknowriad

Message:

Block Editor: Introduce block templates for classic themes.

With this patch, users will be able to create custom block based templates
and assign them to specific pages/posts.

Themes can also opt-out of this feature

Props bernhard-reiter, carlomanf.
Fixes #53176.

Location:

trunk

Files:

• src/wp-admin/edit-form-blocks.php (modified) (1 diff)
• src/wp-includes/block-template-utils.php (added)
• src/wp-includes/block-template.php (added)
• src/wp-includes/class-wp-block-template.php (added)
• src/wp-includes/class-wp-theme.php (modified) (2 diffs)
• src/wp-includes/default-filters.php (modified) (2 diffs)
• src/wp-includes/post.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php (added)
• src/wp-includes/script-loader.php (modified) (1 diff)
• src/wp-includes/taxonomy.php (modified) (1 diff)
• src/wp-includes/template-canvas.php (added)
• src/wp-includes/template.php (modified) (1 diff)
• src/wp-includes/theme-templates.php (added)
• src/wp-settings.php (modified) (2 diffs)
• tests/phpunit/tests/block-template-utils.php (added)
• tests/phpunit/tests/block-template.php (added)
• tests/phpunit/tests/rest-api/rest-schema-setup.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-templates-controller.php (added)
• tests/phpunit/tests/theme/wpThemeJson.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified) (1 diff)

trunk/src/wp-admin/edit-form-blocks.php

@@ -221 +221 @@
     '__experimentalBlockPatterns'          => WP_Block_Patterns_Registry::get_instance()->get_all_registered(),
     '__experimentalBlockPatternCategories' => WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered(),
+    'supportsTemplateMode'                 => current_theme_supports( 'block-templates' ),
 
     // Whether or not to load the 'postcustom' meta box is stored as a user meta

trunk/src/wp-includes/class-wp-theme.php

@@ -1183 +1183 @@
      *
      * @since 4.7.0
+     * @since 5.8.0 Include block templates.
      *
      * @return string[] Array of page templates, keyed by filename and post type,
@@ -1217 +1218 @@
 
                     $post_templates[ $type ][ $file ] = _cleanup_header_comment( $header[1] );
+                }
+            }
+
+            if ( current_theme_supports( 'block-templates' ) ) {
+                $block_templates = get_block_templates( array(), 'wp_template' );
+                foreach ( get_post_types( array( 'public' => true ) ) as $type ) {
+                    foreach ( $block_templates as $block_template ) {
+                        $post_templates[ $type ][ $block_template->slug ] = $block_template->title;
+                    }
                 }
             }

trunk/src/wp-includes/default-filters.php

@@ -556 +556 @@
 add_action( 'wp_footer', 'wp_maybe_inline_styles', 1 ); // Run for late-loaded styles in the footer.
 
+add_action( 'admin_footer-post.php', 'wp_add_iframed_editor_assets_html' );
+add_action( 'admin_footer-post-new.php', 'wp_add_iframed_editor_assets_html' );
+
 // Taxonomy.
 add_action( 'init', 'create_initial_taxonomies', 0 ); // Highest priority.
@@ -634 +637 @@
 add_filter( 'user_has_cap', 'wp_maybe_grant_site_health_caps', 1, 4 );
 
+// Block Templates CPT and Rendering
+add_filter( 'render_block_context', '_block_template_render_without_post_block_context' );
+add_filter( 'pre_wp_unique_post_slug', 'wp_filter_wp_template_unique_post_slug', 10, 5 );
+add_action( 'wp_footer', 'the_block_template_skip_link' );
+
 unset( $filter, $action );

trunk/src/wp-includes/post.php

@@ -305 +305 @@
             'supports'              => array(
                 'title',
+                'editor',
+                'revisions',
+            ),
+        )
+    );
+
+    register_post_type(
+        'wp_template',
+        array(
+            'labels'                => array(
+                'name'                  => __( 'Templates' ),
+                'singular_name'         => __( 'Template' ),
+                'menu_name'             => _x( 'Templates', 'Admin Menu text' ),
+                'add_new'               => _x( 'Add New', 'Template' ),
+                'add_new_item'          => __( 'Add New Template' ),
+                'new_item'              => __( 'New Template' ),
+                'edit_item'             => __( 'Edit Template' ),
+                'view_item'             => __( 'View Template' ),
+                'all_items'             => __( 'All Templates' ),
+                'search_items'          => __( 'Search Templates' ),
+                'parent_item_colon'     => __( 'Parent Template:' ),
+                'not_found'             => __( 'No templates found.' ),
+                'not_found_in_trash'    => __( 'No templates found in Trash.' ),
+                'archives'              => __( 'Template archives' ),
+                'insert_into_item'      => __( 'Insert into template' ),
+                'uploaded_to_this_item' => __( 'Uploaded to this template' ),
+                'filter_items_list'     => __( 'Filter templates list' ),
+                'items_list_navigation' => __( 'Templates list navigation' ),
+                'items_list'            => __( 'Templates list' ),
+            ),
+            'description'           => __( 'Templates to include in your theme.' ),
+            'public'                => false,
+            'has_archive'           => false,
+            'show_ui'               => false,
+            'show_in_menu'          => false,
+            'show_in_admin_bar'     => false,
+            'show_in_rest'          => true,
+            'rewrite'               => false,
+            'rest_base'             => 'templates',
+            'rest_controller_class' => 'WP_REST_Templates_Controller',
+            'capability_type'       => array( 'template', 'templates' ),
+            'capabilities'          => array(
+                'create_posts'           => 'edit_theme_options',
+                'delete_posts'           => 'edit_theme_options',
+                'delete_others_posts'    => 'edit_theme_options',
+                'delete_private_posts'   => 'edit_theme_options',
+                'delete_published_posts' => 'edit_theme_options',
+                'edit_posts'             => 'edit_theme_options',
+                'edit_others_posts'      => 'edit_theme_options',
+                'edit_private_posts'     => 'edit_theme_options',
+                'edit_published_posts'   => 'edit_theme_options',
+                'publish_posts'          => 'edit_theme_options',
+                'read'                   => 'edit_theme_options',
+                'read_private_posts'     => 'edit_theme_options',
+            ),
+            'map_meta_cap'          => true,
+            'supports'              => array(
+                'title',
+                'slug',
+                'excerpt',
                 'editor',
                 'revisions',

trunk/src/wp-includes/script-loader.php

@@ -2663 +2663 @@
     }
 }
+
+/**
+ * Inject the block editor assets that need to be loaded into the editor's iframe as an inline script.
+ *
+ * @since 5.8.0
+ */
+function wp_add_iframed_editor_assets_html() {
+    $script_handles = array();
+    $style_handles  = array(
+        'wp-block-editor',
+        'wp-block-library',
+        'wp-block-library-theme',
+        'wp-edit-blocks',
+    );
+
+    $block_registry = WP_Block_Type_Registry::get_instance();
+
+    foreach ( $block_registry->get_all_registered() as $block_type ) {
+        if ( ! empty( $block_type->style ) ) {
+            $style_handles[] = $block_type->style;
+        }
+
+        if ( ! empty( $block_type->editor_style ) ) {
+            $style_handles[] = $block_type->editor_style;
+        }
+
+        if ( ! empty( $block_type->script ) ) {
+            $script_handles[] = $block_type->script;
+        }
+    }
+
+    $style_handles = array_unique( $style_handles );
+    $done          = wp_styles()->done;
+
+    ob_start();
+
+    wp_styles()->done = array();
+    wp_styles()->do_items( $style_handles );
+    wp_styles()->done = $done;
+
+    $styles = ob_get_clean();
+
+    $script_handles = array_unique( $script_handles );
+    $done           = wp_scripts()->done;
+
+    ob_start();
+
+    wp_scripts()->done = array();
+    wp_scripts()->do_items( $script_handles );
+    wp_scripts()->done = $done;
+
+    $scripts = ob_get_clean();
+
+    $editor_assets = wp_json_encode(
+        array(
+            'styles'  => $styles,
+            'scripts' => $scripts,
+        )
+    );
+
+    echo "<script>window.__editorAssets = $editor_assets</script>";
+}

trunk/src/wp-includes/taxonomy.php

@@ -171 +171 @@
             '_builtin'          => true,
             'show_in_nav_menus' => current_theme_supports( 'post-formats' ),
+        )
+    );
+
+    register_taxonomy(
+        'wp_theme',
+        array( 'wp_template' ),
+        array(
+            'public'            => false,
+            'hierarchical'      => false,
+            'labels'            => array(
+                'name'          => __( 'Themes' ),
+                'singular_name' => __( 'Theme' ),
+            ),
+            'query_var'         => false,
+            'rewrite'           => false,
+            'show_ui'           => false,
+            '_builtin'          => true,
+            'show_in_nav_menus' => false,
+            'show_in_rest'      => false,
         )
     );

trunk/src/wp-includes/template.php

@@ -64 +64 @@
     $template = locate_template( $templates );
 
+    $template = locate_block_template( $template, $type, $templates );
+
     /**
      * Filters the path of the queried template by type.

trunk/src/wp-settings.php

@@ -171 +171 @@
 require ABSPATH . WPINC . '/theme.php';
 require ABSPATH . WPINC . '/class-wp-theme.php';
+require ABSPATH . WPINC . '/class-wp-block-template.php';
+require ABSPATH . WPINC . '/block-template-utils.php';
+require ABSPATH . WPINC . '/block-template.php';
+require ABSPATH . WPINC . '/theme-templates.php';
 require ABSPATH . WPINC . '/template.php';
 require ABSPATH . WPINC . '/https-detection.php';
@@ -269 +273 @@
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-widget-types-controller.php';
 require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-widgets-controller.php';
+require ABSPATH . WPINC . '/rest-api/endpoints/class-wp-rest-templates-controller.php';
 require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-meta-fields.php';
 require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-comment-meta-fields.php';

trunk/tests/phpunit/tests/rest-api/rest-schema-setup.php

@@ -130 +130 @@
             '/wp/v2/block-types/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)',
             '/wp/v2/settings',
+            '/wp/v2/templates',
+            '/wp/v2/templates/(?P<id>[\/\w-]+)',
+            '/wp/v2/templates/(?P<id>[\d]+)/autosaves',
+            '/wp/v2/templates/(?P<parent>[\d]+)/autosaves/(?P<id>[\d]+)',
+            '/wp/v2/templates/(?P<parent>[\d]+)/revisions',
+            '/wp/v2/templates/(?P<parent>[\d]+)/revisions/(?P<id>[\d]+)',
             '/wp/v2/themes',
             '/wp/v2/themes/(?P<stylesheet>[\w-]+)',

trunk/tests/phpunit/tests/theme/wpThemeJson.php

@@ -6 +6 @@
  * @package WordPress
  * @subpackage Theme
+ *
  * @since 5.8.0
  *

trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

@@ -6 +6 @@
  * @package WordPress
  * @subpackage Theme
+ *
  * @since 5.8.0
  *