Changeset 57021

Timestamp:

10/27/2023 07:02:54 PM (12 months ago)

Author:

joemcgill

Message:

Upgrade/Install: Skip registering theme block patterns during the upgrade process.

This fixes a bug during the database upgrade process where a theme's functions.php file may not be loaded, leading to potential exceptions if the theme's pattern files use symbols (classes, functions, constants, etc.) that are declared only when the functions.php file is loaded. To do so, a check for wp_get_active_and_valid_themes() is added early to _register_theme_block_patterns(), which returns early if no active or valid themes are returned.

Props fabiankaegy, rajinsharwar, pbiron, huzaifaalmesbah, hellofromTonya, peterwilsoncc, joemcgill.
Fixes #59723.

Location:

trunk

Files:

• src/wp-includes/block-patterns.php (modified) (1 diff)
• tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php (modified) (1 diff)

trunk/src/wp-includes/block-patterns.php

@@ -329 +329 @@
  */
 function _register_theme_block_patterns() {
+
+    /*
+     * During the bootstrap process, a check for active and valid themes is run.
+     * If no themes are returned, the theme's functions.php file will not be loaded,
+     * which can lead to errors if patterns expect some variables or constants to
+     * already be set at this point, so bail early if that is the case.
+     */
+    if ( empty( wp_get_active_and_valid_themes() ) ) {
+        return;
+    }
+
     /*
      * Register patterns for the active theme. If the theme is a child theme,

trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php

@@ -483 +483 @@
         $this->assertTrue( $result );
     }
+
+    /**
+     * Ensures theme patterns are registered on init.
+     *
+     * @ticket 59723
+     *
+     * @covers ::_register_theme_block_patterns
+     */
+    public function test_register_theme_block_patterns_on_init() {
+        // This test needs to use access static class properties.
+        $registry = WP_Block_Patterns_Registry::get_instance();
+
+        // Ensure we're using a theme with patterns.
+        switch_theme( 'twentytwentythree' );
+
+        $theme          = wp_get_theme();
+        $theme_patterns = array_values( wp_list_pluck( $theme->get_block_patterns(), 'slug' ) );
+
+        // This helper is fired on the init hook.
+        _register_theme_block_patterns();
+
+        $registered = wp_list_pluck( $registry->get_all_registered(), 'name' );
+
+        // Cleanup patterns registry.
+        foreach ( $theme_patterns as $pattern ) {
+            $registry->unregister( $pattern );
+        }
+
+        $this->assertSameSets( $theme_patterns, array_intersect( $theme_patterns, $registered ), 'Could not confirm theme patterns were registered.' );
+    }
+
+    /**
+     * Ensures theme patterns are not registered when no themes are active and valid.
+     *
+     * @ticket 59723
+     *
+     * @covers ::_register_theme_block_patterns
+     */
+    public function test_register_theme_block_patterns_on_init_skipped_during_install() {
+        // This test needs to use access static class properties.
+        $registry = WP_Block_Patterns_Registry::get_instance();
+
+        // Ensure we're using a theme with patterns.
+        switch_theme( 'twentytwentythree' );
+
+        $theme          = wp_get_theme();
+        $theme_patterns = array_values( wp_list_pluck( $theme->get_block_patterns(), 'slug' ) );
+
+        /*
+         * This will short-circuit theme activation.
+         * @see wp_get_active_and_valid_themes().
+         */
+        wp_installing( true );
+
+        // This helper is fired on the init hook.
+        _register_theme_block_patterns();
+
+        $registered = wp_list_pluck( $registry->get_all_registered(), 'name' );
+
+        // Cleanup.
+        wp_installing( false );
+
+        $this->assertEmpty( array_intersect( $theme_patterns, $registered ), 'Theme patterns were were incorrectly registered.' );
+    }
 }