Changeset 57010

Timestamp:

10/26/2023 06:45:46 PM (12 months ago)

Author:

flixos90

Message:

Themes: Fix block theme supports being added too early, leading to Customizer live preview bugs in 6.4.

The Customizer live preview broke because of [56635], however the root cause for the bug was a lower-level problem that had been present since WordPress 5.8: The block theme specific functions _add_default_theme_supports() and wp_enable_block_templates() were being hooked into the setup_theme action, which fires too early to initialize theme features. Because of that, theme functionality would be initialized before the current theme setup being completed. In the case of the Customizer, that includes overriding which theme is the current theme entirely, thus leading to an inconsistent experience.

This changeset fixes the bug by moving those two callbacks to the after_setup_theme action, which is the appropriate action to initialize theme features.

Props karl94, hellofromTonya, joemcgill, flixos90.
Merges [57009] to the 6.4 branch.
Fixes #59732.
See #18298, #53397, #54597.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• src/wp-includes/default-filters.php (modified) (2 diffs)
• src/wp-includes/theme.php (modified) (1 diff)
• tests/phpunit/tests/block-template.php (modified) (1 diff)
• tests/phpunit/tests/theme.php (modified) (4 diffs)

branches/6.4/src/wp-includes/default-filters.php

@@ -522 +522 @@
 // Theme.
 add_action( 'setup_theme', 'create_initial_theme_features', 0 );
-add_action( 'setup_theme', '_add_default_theme_supports', 1 );
+add_action( 'after_setup_theme', '_add_default_theme_supports', 1 );
 add_action( 'wp_loaded', '_custom_header_background_just_in_time' );
 add_action( 'wp_head', '_custom_logo_header_styles' );
@@ -719 +719 @@
 add_action( 'wp_enqueue_scripts', 'wp_enqueue_block_template_skip_link' );
 add_action( 'wp_footer', 'the_block_template_skip_link' ); // Retained for backwards-compatibility. Unhooked by wp_enqueue_block_template_skip_link().
-add_action( 'setup_theme', 'wp_enable_block_templates' );
+add_action( 'after_setup_theme', 'wp_enable_block_templates', 1 );
 add_action( 'wp_loaded', '_add_template_loader_filters' );
 

branches/6.4/src/wp-includes/theme.php

@@ -4336 +4336 @@
 
 /**
- * Adds default theme supports for block themes when the 'setup_theme' action fires.
- *
- * See {@see 'setup_theme'}.
+ * Adds default theme supports for block themes when the 'after_setup_theme' action fires.
+ *
+ * See {@see 'after_setup_theme'}.
  *
  * @since 5.9.0

branches/6.4/tests/phpunit/tests/block-template.php

@@ -16 +16 @@
         switch_theme( 'block-theme' );
         do_action( 'setup_theme' );
+        do_action( 'after_setup_theme' );
     }
 

branches/6.4/tests/phpunit/tests/theme.php

@@ -747 +747 @@
      * @ticket 54597
      * @ticket 54731
+     * @ticket 59732
      *
      * @dataProvider data_block_theme_has_default_support
@@ -775 +776 @@
         );
 
-        do_action( 'setup_theme' );
+        do_action( 'after_setup_theme' );
 
         $this->assertTrue(
@@ -859 +860 @@
      *
      * @ticket 54597
+     * @ticket 59732
      *
      * @covers ::_add_default_theme_supports
@@ -873 +875 @@
         );
 
-        do_action( 'setup_theme' );
+        do_action( 'after_setup_theme' );
 
         $this->assertTrue(