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

Timestamp:

11/25/2021 10:57:19 AM (4 years ago)

Author:

youknowriad

Message:

Themes: Update the base folders for templates and template parts in block themes.

Block Themes should now use the following folders:

• templates instead of block-templates
• parts instead of block-template-parts

Existing themes and folders will continue to work without impact.

Props bernhard-reiter.
Fixes #54493.

File:

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

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

@@ -19 +19 @@
 if ( ! defined( 'WP_TEMPLATE_PART_AREA_UNCATEGORIZED' ) ) {
     define( 'WP_TEMPLATE_PART_AREA_UNCATEGORIZED', 'uncategorized' );
+}
+
+/**
+ * For backward compatibility reasons,
+ * block themes might be using block-templates or block-template-parts,
+ * this function ensures we fallback to these folders properly.
+ *
+ * @since 5.9.0
+ *
+ * @param string $theme_stylesheet The stylesheet. Default is to leverage the main theme root.
+ *
+ * @return array Folder names used by block themes.
+ */
+function get_block_theme_folders( $theme_stylesheet = null ) {
+    $theme_name = null === $theme_stylesheet ? get_stylesheet() : $theme_stylesheet;
+    $root_dir   = get_theme_root( $theme_name );
+    $theme_dir  = "$root_dir/$theme_name";
+
+    if ( is_readable( $theme_dir . '/block-templates/index.html' ) ) {
+        return array(
+            'wp_template'      => 'block-templates',
+            'wp_template_part' => 'block-template-parts',
+        );
+    }
+
+    return array(
+        'wp_template'      => 'templates',
+        'wp_template_part' => 'parts',
+    );
 }
 
@@ -225 +254 @@
     }
 
-    $template_base_paths = array(
-        'wp_template'      => 'block-templates',
-        'wp_template_part' => 'block-template-parts',
-    );
-    $themes              = array(
+    $themes = array(
         get_stylesheet() => get_stylesheet_directory(),
         get_template()   => get_template_directory(),
     );
     foreach ( $themes as $theme_slug => $theme_dir ) {
-        $file_path = $theme_dir . '/' . $template_base_paths[ $template_type ] . '/' . $slug . '.html';
+        $template_base_paths = get_block_theme_folders( $theme_slug );
+        $file_path           = $theme_dir . '/' . $template_base_paths[ $template_type ] . '/' . $slug . '.html';
         if ( file_exists( $file_path ) ) {
             $new_template_item = array(
@@ -273 +299 @@
     }
 
-    $template_base_paths = array(
-        'wp_template'      => 'block-templates',
-        'wp_template_part' => 'block-template-parts',
-    );
-    $themes              = array(
+    $themes         = array(
         get_stylesheet() => get_stylesheet_directory(),
         get_template()   => get_template_directory(),
     );
-
     $template_files = array();
     foreach ( $themes as $theme_slug => $theme_dir ) {
+        $template_base_paths  = get_block_theme_folders( $theme_slug );
         $theme_template_files = _get_block_templates_paths( $theme_dir . '/' . $template_base_paths[ $template_type ] );
         foreach ( $theme_template_files as $template_file ) {