Changeset 59073 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php

Timestamp:

09/20/2024 02:05:50 AM (14 months 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/rest-api/endpoints/class-wp-rest-templates-controller.php (modified) (5 diffs)

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

@@ -327 +327 @@
      */
     public function get_item( $request ) {
-        if ( isset( $request['source'] ) && 'theme' === $request['source'] ) {
+        if ( isset( $request['source'] ) && ( 'theme' === $request['source'] || 'plugin' === $request['source'] ) ) {
             $template = get_block_file_template( $request['id'], $this->post_type );
         } else {
@@ -777 +777 @@
         }
 
+        if ( rest_is_field_included( 'plugin', $fields ) ) {
+            $registered_template = WP_Block_Templates_Registry::get_instance()->get_by_slug( $template->slug );
+            if ( $registered_template ) {
+                $data['plugin'] = $registered_template->plugin;
+            }
+        }
+
         $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
         $data    = $this->add_additional_fields_to_object( $data, $request );
@@ -832 +839 @@
 
             // Added by plugin.
-            if ( $template_object->has_theme_file && 'plugin' === $template_object->origin ) {
+            if ( 'plugin' === $template_object->origin ) {
                 return 'plugin';
             }
@@ -866 +873 @@
                 return empty( $theme_name ) ? $template_object->theme : $theme_name;
             case 'plugin':
-                $plugins = get_plugins();
-                $plugin  = $plugins[ plugin_basename( sanitize_text_field( $template_object->theme . '.php' ) ) ];
-                return empty( $plugin['Name'] ) ? $template_object->theme : $plugin['Name'];
+                if ( ! function_exists( 'get_plugins' ) || ! function_exists( 'get_plugin_data' ) ) {
+                    require_once ABSPATH . 'wp-admin/includes/plugin.php';
+                }
+                if ( isset( $template_object->plugin ) ) {
+                    $plugins = wp_get_active_and_valid_plugins();
+
+                    foreach ( $plugins as $plugin_file ) {
+                        $plugin_basename = plugin_basename( $plugin_file );
+                        // Split basename by '/' to get the plugin slug.
+                        list( $plugin_slug, ) = explode( '/', $plugin_basename );
+
+                        if ( $plugin_slug === $template_object->plugin ) {
+                            $plugin_data = get_plugin_data( $plugin_file );
+
+                            if ( ! empty( $plugin_data['Name'] ) ) {
+                                return $plugin_data['Name'];
+                            }
+
+                            break;
+                        }
+                    }
+                }
+
+                /*
+                 * Fall back to the theme name if the plugin is not defined. That's needed to keep backwards
+                 * compatibility with templates that were registered before the plugin attribute was added.
+                 */
+                $plugins         = get_plugins();
+                $plugin_basename = plugin_basename( sanitize_text_field( $template_object->theme . '.php' ) );
+                if ( isset( $plugins[ $plugin_basename ] ) && isset( $plugins[ $plugin_basename ]['Name'] ) ) {
+                    return $plugins[ $plugin_basename ]['Name'];
+                }
+                return isset( $template_object->plugin ) ?
+                    $template_object->plugin :
+                    $template_object->theme;
             case 'site':
                 return get_bloginfo( 'name' );
@@ -1135 +1174 @@
                 'readonly'    => true,
             );
+            $schema['properties']['plugin']    = array(
+                'type'        => 'string',
+                'description' => __( 'Plugin that registered the template.' ),
+                'readonly'    => true,
+                'context'     => array( 'view', 'edit', 'embed' ),
+            );
         }