Changeset 53416

Timestamp:

05/20/2022 12:47:45 AM (3 years ago)

Author:

peterwilsoncc

Message:

Themes: Accept valid block themes.

Updates theme validation to accept block themes. This replaces the requirement for an index.php with a requirement for either an index.php, /templates/index.html or the deprecated /block-templates/index.html.

Validation is updated for theme uploads, within WP_Theme::__construct and validate_current_theme().

A block theme using the deprecated file structure is now included in the unit tests.

Props peterwilsoncc, sergeybiryukov, hellofromtonya, costdev, azaozz, gziolo, FlorianBrinkmann, Boniu91, aristath, poena, audrasjb.
Fixes #55754.

Location:

trunk

Files:

• src/wp-admin/includes/class-theme-upgrader.php (modified) (1 diff)
• src/wp-includes/class-wp-theme.php (modified) (1 diff)
• src/wp-includes/theme.php (modified) (1 diff)
• tests/phpunit/data/themedir1/block-theme-deprecated-path (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/block-templates (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/block-templates/index.html (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/block-templates/page-home.html (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/block-templates/page.html (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/parts (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/parts/small-header.html (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/style.css (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/styles (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/styles/variation.json (added)
• tests/phpunit/data/themedir1/block-theme-deprecated-path/theme.json (added)
• tests/phpunit/tests/rest-api/wpRestTemplatesController.php (modified) (1 diff)
• tests/phpunit/tests/theme/themeDir.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpTheme.php (modified) (2 diffs)

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

@@ -567 +567 @@
         }
 
-        // If it's not a child theme, it must have at least an index.php to be legit.
-        if ( empty( $info['Template'] ) && ! file_exists( $working_directory . 'index.php' ) ) {
+        /*
+         * Parent themes must contain an index file:
+         * - classic themes require /index.php
+         * - block themes require /templates/index.html or block-templates/index.html (deprecated 5.9.0).
+         */
+        if (
+            empty( $info['Template'] ) &&
+            ! file_exists( $working_directory . 'index.php' ) &&
+            ! file_exists( $working_directory . 'templates/index.html' ) &&
+            ! file_exists( $working_directory . 'block-templates/index.html' )
+        ) {
             return new WP_Error(
                 'incompatible_archive_theme_no_index',
                 $this->strings['incompatible_archive'],
                 sprintf(
-                    /* translators: %s: index.php */
-                    __( 'The theme is missing the %s file.' ),
-                    '<code>index.php</code>'
+                    /* translators: 1: templates/index.html, 2: index.php, 3: Documentation URL, 4: Template, 5: style.css */
+                    __( 'Template is missing. Standalone themes need to have a %1$s or %2$s template file. <a href="%3$s">Child themes</a> need to have a %4$s header in the %5$s stylesheet.' ),
+                    '<code>templates/index.html</code>',
+                    '<code>index.php</code>',
+                    __( 'https://developer.wordpress.org/themes/advanced-topics/child-themes/' ),
+                    '<code>Template</code>',
+                    '<code>style.css</code>'
                 )
             );

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

@@ -342 +342 @@
             $theme_path     = $this->theme_root . '/' . $this->stylesheet;
 
-            if ( ! file_exists( $theme_path . '/templates/index.html' )
+            if (
+                ! file_exists( $theme_path . '/templates/index.html' )
+                && ! file_exists( $theme_path . '/block-templates/index.html' ) // Deprecated path support since 5.9.0.
                 && ! file_exists( $theme_path . '/index.php' )
             ) {

trunk/src/wp-includes/theme.php

@@ -862 +862 @@
     }
 
-    if ( ! file_exists( get_template_directory() . '/templates/index.html' )
+    if (
+        ! file_exists( get_template_directory() . '/templates/index.html' )
+        && ! file_exists( get_template_directory() . '/block-templates/index.html' ) // Deprecated path support since 5.9.0.
         && ! file_exists( get_template_directory() . '/index.php' )
     ) {

trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

@@ -286 +286 @@
                     'post_title'   => 'Home Page Template',
                     'post_content' => file_get_contents( $theme_root_dir . 'block-theme/templates/page-home.html' ),
+                    'post_excerpt' => 'Description of page home template.',
+                ),
+            ),
+            'template: parent theme deprecated path'      => array(
+                'theme_dir' => 'themedir1/block-theme-deprecated-path',
+                'template'  => 'page-home',
+                'args'      => array(
+                    'post_name'    => 'page-home',
+                    'post_title'   => 'Home Page Template',
+                    'post_content' => file_get_contents( $theme_root_dir . 'block-theme-deprecated-path/block-templates/page-home.html' ),
                     'post_excerpt' => 'Description of page home template.',
                 ),

trunk/tests/phpunit/tests/theme/themeDir.php

@@ -166 +166 @@
             'Block Theme [0.4.0]',
             'Block Theme [1.0.0] in subdirectory',
+            'Block Theme Deprecated Path',
             'Webfonts theme',
             'Empty `fontFace` in theme.json - no webfonts defined',
         );
 
-        sort( $theme_names );
-        sort( $expected );
-
-        $this->assertSame( $expected, $theme_names );
+        $this->assertSameSets( $expected, $theme_names );
     }
 

trunk/tests/phpunit/tests/theme/wpTheme.php

@@ -310 +310 @@
                 'expected'  => true,
             ),
+            'deprecated block theme'    => array(
+                'theme_dir' => 'block-theme-deprecated-path',
+                'expected'  => true,
+            ),
         );
     }
@@ -336 +340 @@
     public function data_get_file_path() {
         return array(
-            'no theme: no file given'           => array(
+            'no theme: no file given'              => array(
                 'theme_dir' => 'nonexistent',
                 'file'      => '',
                 'expected'  => '/nonexistent',
             ),
-            'parent theme: no file given'       => array(
+            'parent theme: no file given'          => array(
                 'theme_dir' => 'block-theme',
                 'file'      => '',
                 'expected'  => '/block-theme',
             ),
-            'child theme: no file given'        => array(
+            'child theme: no file given'           => array(
                 'theme_dir' => 'block-theme-child',
                 'file'      => '',
                 'expected'  => '/block-theme-child',
             ),
-            'nonexistent theme: file given'     => array(
+            'nonexistent theme: file given'        => array(
                 'theme_dir' => 'nonexistent',
                 'file'      => '/templates/page.html',
                 'expected'  => '/nonexistent/templates/page.html',
             ),
-            'parent theme: file exists'         => array(
+            'parent theme: file exists'            => array(
                 'theme_dir' => 'block-theme',
                 'file'      => '/templates/page-home.html',
                 'expected'  => '/block-theme/templates/page-home.html',
             ),
-            'parent theme: file does not exist' => array(
+            'parent theme: deprecated file exists' => array(
+                'theme_dir' => 'block-theme-deprecated-path',
+                'file'      => '/block-templates/page-home.html',
+                'expected'  => '/block-theme-deprecated-path/block-templates/page-home.html',
+            ),
+            'parent theme: file does not exist'    => array(
                 'theme_dir' => 'block-theme',
                 'file'      => '/templates/nonexistent.html',
                 'expected'  => '/block-theme/templates/nonexistent.html',
             ),
-            'child theme: file exists'          => array(
+            'child theme: file exists'             => array(
                 'theme_dir' => 'block-theme-child',
                 'file'      => '/templates/page-1.html',
                 'expected'  => '/block-theme-child/templates/page-1.html',
             ),
-            'child theme: file does not exist'  => array(
+            'child theme: file does not exist'     => array(
                 'theme_dir' => 'block-theme-child',
                 'file'      => '/templates/nonexistent.html',