Changeset 52279

Timestamp:

11/30/2021 02:25:34 PM (3 years ago)

Author:

hellofromTonya

Message:

Administration: For block themes, link to Site Editor interface instead of Customizer in Dashboard's welcome panel and Themes interface.

For block themes (like Twenty Twenty-Two), Customizer menu item is removed and replaced with the Site Editor menu item. However, other links exist in the Dashboard's welcome panel "Customize Your Site" button and the "Customize" button in each theme listed in the Appearance > Themes interface.

This commit changes each of those remaining links to link to the Site Editor interface instead of the Customizer.

To help identify block vs non-block themes, two method methods are introduced in WP_Theme:

• WP_Theme:: is_block_based() which identifies if the theme is a block theme or not.
• WP_Theme::get_file_path() which is similar to get_theme_file_path() but uses the directories within the theme object.

Both of these new methods include test coverage including the addition of a parent and child block theme in test data.

Follow-up to [18749], [35483], [42013], [42169].

Props antonvlasenko, jameskoster, hellofromTonya, matveb, noisysocks, poena, sergeybiryukov.
Fixes #54460.

Location:

trunk

Files:

• src/wp-admin/includes/dashboard.php (modified) (2 diffs)
• src/wp-admin/includes/theme.php (modified) (1 diff)
• src/wp-admin/theme-editor.php (modified) (1 diff)
• src/wp-includes/class-wp-theme.php (modified) (1 diff)
• tests/phpunit/data/themedir1/test-block-child-theme (added)
• tests/phpunit/data/themedir1/test-block-child-theme/page-home.php (added)
• tests/phpunit/data/themedir1/test-block-child-theme/style.css (added)
• tests/phpunit/data/themedir1/test-block-child-theme/templates (added)
• tests/phpunit/data/themedir1/test-block-child-theme/templates/page-1.html (added)
• tests/phpunit/data/themedir1/test-block-theme (added)
• tests/phpunit/data/themedir1/test-block-theme/index.php (added)
• tests/phpunit/data/themedir1/test-block-theme/page-1.php (added)
• tests/phpunit/data/themedir1/test-block-theme/style.css (added)
• tests/phpunit/data/themedir1/test-block-theme/templates (added)
• tests/phpunit/data/themedir1/test-block-theme/templates/index.html (added)
• tests/phpunit/data/themedir1/test-block-theme/templates/page-home.html (added)
• tests/phpunit/data/themedir1/test-block-theme/templates/page.html (added)
• tests/phpunit/tests/theme/themeDir.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpTheme.php (modified) (1 diff)

trunk/src/wp-admin/includes/dashboard.php

@@ -1988 +1988 @@
  *
  * @since 3.3.0
+ * @since 5.9.0 Send users to the Site Editor if the current theme is block-based.
  */
 function wp_welcome_panel() {
+    $customize_url          = null;
+    $can_edit_theme_options = current_user_can( 'edit_theme_options' );
+    $can_customize          = current_user_can( 'customize' );
+    $is_block_based_theme   = wp_is_block_template_theme();
+
+    if ( $is_block_based_theme && $can_edit_theme_options ) {
+        $customize_url = esc_url( admin_url( 'site-editor.php' ) );
+    } elseif ( ! $is_block_based_theme && $can_customize ) {
+        $customize_url = wp_customize_url();
+    }
     ?>
     <div class="welcome-panel-content">
@@ -1996 +2007 @@
     <div class="welcome-panel-column-container">
     <div class="welcome-panel-column">
-        <?php if ( current_user_can( 'customize' ) ) : ?>
+        <?php if ( $customize_url ) : ?>
             <h3><?php _e( 'Get Started' ); ?></h3>
-            <a class="button button-primary button-hero load-customize hide-if-no-customize" href="<?php echo wp_customize_url(); ?>"><?php _e( 'Customize Your Site' ); ?></a>
+            <a class="button button-primary button-hero load-customize hide-if-no-customize" href="<?php echo $customize_url; ?>"><?php _e( 'Customize Your Site' ); ?></a>
         <?php endif; ?>
         <a class="button button-primary button-hero hide-if-customize" href="<?php echo esc_url( admin_url( 'themes.php' ) ); ?>"><?php _e( 'Customize Your Site' ); ?></a>
         <?php if ( current_user_can( 'install_themes' ) || ( current_user_can( 'switch_themes' ) && count( wp_get_themes( array( 'allowed' => true ) ) ) > 1 ) ) : ?>
-            <?php $themes_link = current_user_can( 'customize' ) ? add_query_arg( 'autofocus[panel]', 'themes', admin_url( 'customize.php' ) ) : admin_url( 'themes.php' ); ?>
+            <?php $themes_link = $can_customize && ! $is_block_based_theme ? add_query_arg( 'autofocus[panel]', 'themes', admin_url( 'customize.php' ) ) : admin_url( 'themes.php' ); ?>
             <p class="hide-if-no-customize">
                 <?php

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

@@ -702 +702 @@
 
         $customize_action = null;
-        if ( current_user_can( 'edit_theme_options' ) && current_user_can( 'customize' ) ) {
+
+        $can_edit_theme_options = current_user_can( 'edit_theme_options' );
+        $can_customize          = current_user_can( 'customize' );
+        $is_block_based_theme   = $theme->is_block_based();
+
+        if ( $is_block_based_theme && $can_edit_theme_options ) {
+            $customize_action = esc_url( admin_url( 'site-editor.php' ) );
+        } elseif ( ! $is_block_based_theme && $can_customize && $can_edit_theme_options ) {
             $customize_action = esc_url(
                 add_query_arg(

trunk/src/wp-admin/theme-editor.php

@@ -197 +197 @@
 <?php endif; ?>
 
-<?php if ( preg_match( '/\.css$/', $file ) ) : ?>
+<?php if ( preg_match( '/\.css$/', $file ) && ! wp_is_block_template_theme() && current_user_can( 'customize' ) ) : ?>
     <div id="message" class="notice-info notice">
         <p><strong><?php _e( 'Did you know?' ); ?></strong></p>

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

@@ -1462 +1462 @@
 
     /**
+     * Returns whether this theme is a block-based theme or not.
+     *
+     * @since 5.9.0
+     *
+     * @return bool
+     */
+    public function is_block_based() {
+        $paths_to_index_block_template = array(
+            $this->get_file_path( '/block-templates/index.html' ),
+            $this->get_file_path( '/templates/index.html' ),
+        );
+
+        foreach ( $paths_to_index_block_template as $path_to_index_block_template ) {
+            if ( is_file( $path_to_index_block_template ) && is_readable( $path_to_index_block_template ) ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Retrieves the path of a file in the theme.
+     *
+     * Searches in the stylesheet directory before the template directory so themes
+     * which inherit from a parent theme can just override one file.
+     *
+     * @since 5.9.0
+     *
+     * @param string $file Optional. File to search for in the stylesheet directory.
+     * @return string The path of the file.
+     */
+    public function get_file_path( $file = '' ) {
+        $file = ltrim( $file, '/' );
+
+        $stylesheet_directory = $this->get_stylesheet_directory();
+        $template_directory   = $this->get_template_directory();
+
+        if ( empty( $file ) ) {
+            $path = $stylesheet_directory;
+        } elseif ( file_exists( $stylesheet_directory . '/' . $file ) ) {
+            $path = $stylesheet_directory . '/' . $file;
+        } else {
+            $path = $template_directory . '/' . $file;
+        }
+
+        /**
+         * Filters the path to a file in the theme.
+         *
+         * @since 5.9.0
+         *
+         * @param string $path The file path.
+         * @param string $file The requested file to search for.
+         */
+        return apply_filters( 'theme_file_path', $path, $file );
+    }
+
+    /**
      * Determines the latest WordPress default theme that is installed.
      *

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

@@ -164 +164 @@
             'Block Theme',
             'Block Theme Child Theme',
+            'Test Block Theme',
+            'Test Block Child Theme',
         );
 

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

@@ -247 +247 @@
         $this->assertSameSetsWithIndex( $allowed_themes, $new_allowed_themes );
     }
+
+    /**
+     * @dataProvider data_is_block_based
+     * @ticket 54460
+     *
+     * @covers WP_Theme::is_block_based
+     *
+     * @param string $theme_dir Directory of the theme to test.
+     * @param bool   $expected  Expected result.
+     */
+    public function test_is_block_based( $theme_dir, $expected ) {
+        $theme  = new WP_Theme( $theme_dir, $this->theme_root );
+        $actual = $theme->is_block_based();
+
+        if ( $expected ) {
+            $this->assertTrue( $actual );
+        } else {
+            $this->assertFalse( $actual );
+        }
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_is_block_based() {
+        return array(
+            'default - non-block theme' => array(
+                'theme_dir' => 'default',
+                'expected'  => false,
+            ),
+            'parent block theme'        => array(
+                'theme_dir' => 'test-block-theme',
+                'expected'  => true,
+            ),
+            'child block theme'         => array(
+                'theme_dir' => 'test-block-child-theme',
+                'expected'  => true,
+            ),
+        );
+    }
+
+    /**
+     * @dataProvider data_get_file_path
+     * @ticket 54460
+     *
+     * @covers WP_Theme::get_file_path
+     *
+     * @param string $theme_dir Directory of the theme to test.
+     * @param string $file      Given file name to test.
+     * @param string $expected  Expected file path.
+     */
+    public function test_get_file_path( $theme_dir, $file, $expected ) {
+        $theme = new WP_Theme( $theme_dir, $this->theme_root );
+
+        $this->assertStringEndsWith( $expected, $theme->get_file_path( $file ) );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_get_file_path() {
+        return array(
+            'no theme: no file given'           => array(
+                'theme_dir' => 'nonexistent',
+                'file'      => '',
+                'expected'  => '/nonexistent',
+            ),
+            'parent theme: no file given'       => array(
+                'theme_dir' => 'test-block-theme',
+                'file'      => '',
+                'expected'  => '/test-block-theme',
+            ),
+            'child theme: no file given'        => array(
+                'theme_dir' => 'test-block-child-theme',
+                'file'      => '',
+                'expected'  => '/test-block-child-theme',
+            ),
+            'nonexistent theme: file given'     => array(
+                'theme_dir' => 'nonexistent',
+                'file'      => '/templates/page.html',
+                'expected'  => '/nonexistent/templates/page.html',
+            ),
+            'parent theme: file exists'         => array(
+                'theme_dir' => 'test-block-theme',
+                'file'      => '/templates/page-home.html',
+                'expected'  => '/test-block-theme/templates/page-home.html',
+            ),
+            'parent theme: file does not exist' => array(
+                'theme_dir' => 'test-block-theme',
+                'file'      => '/templates/nonexistent.html',
+                'expected'  => '/test-block-theme/templates/nonexistent.html',
+            ),
+            'child theme: file exists'          => array(
+                'theme_dir' => 'test-block-child-theme',
+                'file'      => '/templates/page-1.html',
+                'expected'  => '/test-block-child-theme/templates/page-1.html',
+            ),
+            'child theme: file does not exist'  => array(
+                'theme_dir' => 'test-block-child-theme',
+                'file'      => '/templates/nonexistent.html',
+                'expected'  => '/test-block-theme/templates/nonexistent.html',
+            ),
+            'child theme: file exists in parent, not in child' => array(
+                'theme_dir' => 'test-block-child-theme',
+                'file'      => '/templates/page.html',
+                'expected'  => '/test-block-theme/templates/page.html',
+            ),
+        );
+    }
 }