Changeset 52593

Timestamp:

01/17/2022 10:40:51 PM (3 years ago)

Author:

hellofromTonya

Message:

Editor: Explicitly load remote block patterns in the block and site editor screens.

Remote block patterns from wp.org were to be loaded through a callback hooked into the current_screen filter. Within 2 callbacks, i.e. _load_remote_featured_patterns() and _load_remote_block_patterns(), a guard clause bailed out early if the $current_screen->is_block_editor is false.

However, the current_screen filter is unreliable to detect the block editor. Why? In the block and Site Editor screens, $current_scren->is_block_editor is not set until after the filter is executed. Whoopsie.

This commit no longer uses the current_screen filter. Instead, it explicitly loads the remote block patterns by invoking both private functions (now not callbacks) directly in the screen files for the block and site editor screens.

With this change, passing WP_Screen object into these functions is no longer needed. As the _load_remote_block_patterns() function was introduced in 5.8.0, its function parameter is now deprecated and the guard clause retained for backwards compatibility.

Follow-up to [51021], [52377].

Props poena, noisysocks, peterwilsoncc, hellofromTonya, audrasjb.
Fixes #54806.

Location:

trunk/src

Files:

• wp-admin/edit-form-blocks.php (modified) (1 diff)
• wp-admin/site-editor.php (modified) (1 diff)
• wp-includes/block-patterns.php (modified) (2 diffs)
• wp-includes/default-filters.php (modified) (1 diff)

trunk/src/wp-admin/edit-form-blocks.php

@@ -28 +28 @@
 $current_screen = get_current_screen();
 $current_screen->is_block_editor( true );
+
+// Load block patterns from w.org.
+_load_remote_block_patterns();
+_load_remote_featured_patterns();
 
 // Default to is-fullscreen-mode to avoid jumps in the UI.

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

@@ -31 +31 @@
 $current_screen = get_current_screen();
 $current_screen->is_block_editor( true );
+
+// Load block patterns from w.org.
+_load_remote_block_patterns();
+_load_remote_featured_patterns();
 
 // Default to is-fullscreen-mode to avoid jumps in the UI.

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

@@ -49 +49 @@
  *
  * @since 5.8.0
+ * @since 5.9.0 The $current_screen argument was removed.
  *
- * @param WP_Screen $current_screen The screen that the current request was triggered from.
+ * @param WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.
  */
-function _load_remote_block_patterns( $current_screen ) {
-    if ( ! $current_screen->is_block_editor ) {
-        return;
+function _load_remote_block_patterns( $deprecated = null ) {
+    if ( ! empty( $deprecated ) ) {
+        _deprecated_argument( __FUNCTION__, '5.9.0' );
+        $current_screen = $deprecated;
+        if ( ! $current_screen->is_block_editor ) {
+            return;
+        }
     }
 
@@ -89 +94 @@
  *
  * @since 5.9.0
- *
- * @param WP_Screen $current_screen The screen that the current request was triggered from.
  */
-function _load_remote_featured_patterns( $current_screen ) {
-    if ( ! $current_screen->is_block_editor ) {
-        return;
-    }
-
+function _load_remote_featured_patterns() {
     $supports_core_patterns = get_theme_support( 'core-block-patterns' );
 

trunk/src/wp-includes/default-filters.php

@@ -333 +333 @@
 add_action( 'wp_print_footer_scripts', '_wp_footer_scripts' );
 add_action( 'init', '_register_core_block_patterns_and_categories' );
-add_action( 'current_screen', '_load_remote_block_patterns' );
-add_action( 'current_screen', '_load_remote_featured_patterns' );
 add_action( 'init', 'check_theme_switched', 99 );
 add_action( 'init', array( 'WP_Block_Supports', 'init' ), 22 );