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

Timestamp:

09/20/2024 02:05:50 AM (2 years ago)

Author:

noisysocks

Message:

Editor: Add plugin template registration API and improve theme overrides for plugin-registered templates

This commit introduces a new API to allow plugins to easily register block
templates with wp_register_block_template() and the
WP_Block_Templates_Registry class, addressing the complexity of hooking into
multiple filters. It also ensures plugin-registered templates overridden by
themes fall back to the plugin-provided title and description when the theme
doesn't define them.

See ​https://github.com/WordPress/gutenberg/pull/61577.
See ​https://github.com/WordPress/gutenberg/pull/64610.

Fixes #61804.
Props aljullu, peterwilsoncc, antonvlasenko, azaozz, youknowriad, noisysocks.

File:

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

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

@@ -592 +592 @@
         $template->is_custom      = true;
         $template->modified       = null;
+
+        if ( 'wp_template' === $template_type ) {
+                $registered_template = WP_Block_Templates_Registry::get_instance()->get_by_slug( $template_file['slug'] );
+                if ( $registered_template ) {
+                        $template->plugin      = $registered_template->plugin;
+                        $template->title       = empty( $template->title ) || $template->title === $template->slug ? $registered_template->title : $template->title;
+                        $template->description = empty( $template->description ) ? $registered_template->description : $template->description;
+                }
+        }
 
         if ( 'wp_template' === $template_type && isset( $default_template_types[ $template_file['slug'] ] ) ) {
@@ -1015 +1024 @@
         }
 
+        if ( 'wp_template' === $post->post_type ) {
+                $registered_template = WP_Block_Templates_Registry::get_instance()->get_by_slug( $template->slug );
+                if ( $registered_template ) {
+                        $template->plugin      = $registered_template->plugin;
+                        $template->origin      =
+                                'theme' !== $template->origin && 'theme' !== $template->source ?
+                                'plugin' :
+                                $template->origin;
+                        $template->title       = empty( $template->title ) || $template->title === $template->slug ? $registered_template->title : $template->title;
+                        $template->description = empty( $template->description ) ? $registered_template->description : $template->description;
+                }
+        }
+
         $hooked_blocks = get_hooked_blocks();
         if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) {
@@ -1158 +1180 @@
                         $query_result[] = _build_block_template_result_from_file( $template_file, $template_type );
                 }
+
+                if ( 'wp_template' === $template_type ) {
+                        // Add templates registered in the template registry. Filtering out the ones which have a theme file.
+                        $registered_templates          = WP_Block_Templates_Registry::get_instance()->get_by_query( $query );
+                        $matching_registered_templates = array_filter(
+                                $registered_templates,
+                                function ( $registered_template ) use ( $template_files ) {
+                                        foreach ( $template_files as $template_file ) {
+                                                if ( $template_file['slug'] === $registered_template->slug ) {
+                                                        return false;
+                                                }
+                                        }
+                                        return true;
+                                }
+                        );
+                        $query_result                  = array_merge( $query_result, $matching_registered_templates );
+                }
         }
 
@@ -1288 +1327 @@
         list( $theme, $slug ) = $parts;
 
-        if ( get_stylesheet() !== $theme ) {
-                /** This filter is documented in wp-includes/block-template-utils.php */
-                return apply_filters( 'get_block_file_template', null, $id, $template_type );
-        }
-
-        $template_file = _get_block_template_file( $template_type, $slug );
-        if ( null === $template_file ) {
-                /** This filter is documented in wp-includes/block-template-utils.php */
-                return apply_filters( 'get_block_file_template', null, $id, $template_type );
-        }
-
-        $block_template = _build_block_template_result_from_file( $template_file, $template_type );
+        if ( get_stylesheet() === $theme ) {
+                $template_file = _get_block_template_file( $template_type, $slug );
+                if ( null !== $template_file ) {
+                        $block_template = _build_block_template_result_from_file( $template_file, $template_type );
+
+                        /** This filter is documented in wp-includes/block-template-utils.php */
+                        return apply_filters( 'get_block_file_template', $block_template, $id, $template_type );
+                }
+        }
+
+        $block_template = WP_Block_Templates_Registry::get_instance()->get_by_slug( $slug );
 
         /**
@@ -1666 +1704 @@
                 }
 
-                $content = get_comment_delimited_block_content(
+                $content               = get_comment_delimited_block_content(
                         'core/template-part',
                         $attributes,
                         $changes->post_content
                 );
-                $content = apply_block_hooks_to_content( $content, $template, 'set_ignored_hooked_blocks_metadata' );
+                $content               = apply_block_hooks_to_content( $content, $template, 'set_ignored_hooked_blocks_metadata' );
                 $changes->post_content = remove_serialized_parent_block( $content );