Changeset 53404

Timestamp:

05/17/2022 02:36:22 PM (2 years ago)

Author:

gziolo

Message:

Editor: Return additional block patterns to server-generated settings

Reverts changes from [53155] to ensure backward compatibility.

Companion to Gutenberg changes ​https://github.com/WordPress/gutenberg/pull/40818. That makes sure that patterns registered with admin_init or current_screen hooks are not lost.

Props jsnajdr, zieladam, peterwilsoncc, johnstonphilip.
See #55567.

Location:

trunk/src

Files:

• wp-admin/edit-form-blocks.php (modified) (1 diff)
• wp-admin/site-editor.php (modified) (1 diff)
• wp-includes/class-wp-block-pattern-categories-registry.php (modified) (4 diffs)
• wp-includes/class-wp-block-patterns-registry.php (modified) (4 diffs)

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

@@ -210 +210 @@
 );
 
+// Add additional back-compat patterns registered by `current_screen` et al.
+$editor_settings['__experimentalAdditionalBlockPatterns']          = WP_Block_Patterns_Registry::get_instance()->get_all_registered( true );
+$editor_settings['__experimentalAdditionalBlockPatternCategories'] = WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered( true );
+
 $autosave = wp_get_post_autosave( $post->ID );
 if ( $autosave ) {

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

@@ -69 +69 @@
     '__unstableHomeTemplate'   => $home_template,
 );
+
+// Add additional back-compat patterns registered by `current_screen` et al.
+$custom_settings['__experimentalAdditionalBlockPatterns']          = WP_Block_Patterns_Registry::get_instance()->get_all_registered( true );
+$custom_settings['__experimentalAdditionalBlockPatternCategories'] = WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered( true );
+
 $editor_settings      = get_block_editor_settings( $custom_settings, $block_editor_context );
 

trunk/src/wp-includes/class-wp-block-pattern-categories-registry.php

@@ -19 +19 @@
      */
     private $registered_categories = array();
+
+    /**
+     * Pattern categories registered outside the `init` action.
+     *
+     * @since 6.0.0
+     * @var array[]
+     */
+    private $registered_categories_outside_init = array();
 
     /**
@@ -51 +59 @@
         }
 
-        $this->registered_categories[ $category_name ] = array_merge(
+        $category = array_merge(
             array( 'name' => $category_name ),
             $category_properties
         );
+
+        $this->registered_categories[ $category_name ] = $category;
+
+        // If the category is registered inside an action other than `init`, store it
+        // also to a dedicated array. Used to detect deprecated registrations inside
+        // `admin_init` or `current_screen`.
+        if ( current_action() && 'init' !== current_action() ) {
+            $this->registered_categories_outside_init[ $category_name ] = $category;
+        }
 
         return true;
@@ -79 +96 @@
 
         unset( $this->registered_categories[ $category_name ] );
+        unset( $this->registered_categories_outside_init[ $category_name ] );
 
         return true;
@@ -104 +122 @@
      * @since 5.5.0
      *
+     * @param bool $outside_init_only Return only categories registered outside the `init` action.
      * @return array[] Array of arrays containing the registered pattern categories properties.
      */
-    public function get_all_registered() {
-        return array_values( $this->registered_categories );
+    public function get_all_registered( $outside_init_only = false ) {
+        return array_values(
+            $outside_init_only
+                ? $this->registered_categories_outside_init
+                : $this->registered_categories
+        );
     }
 

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

@@ -21 +21 @@
      */
     private $registered_patterns = array();
+
+    /**
+     * Patterns registered outside the `init` action.
+     *
+     * @since 6.0.0
+     * @var array[]
+     */
+    private $registered_patterns_outside_init = array();
 
     /**
@@ -93 +101 @@
         }
 
-        $this->registered_patterns[ $pattern_name ] = array_merge(
+        $pattern = array_merge(
             $pattern_properties,
             array( 'name' => $pattern_name )
         );
+        $this->registered_patterns[ $pattern_name ] = $pattern;
+
+        // If the pattern is registered inside an action other than `init`, store it
+        // also to a dedicated array. Used to detect deprecated registrations inside
+        // `admin_init` or `current_screen`.
+        if ( current_action() && 'init' !== current_action() ) {
+            $this->registered_patterns_outside_init[ $pattern_name ] = $pattern;
+        }
 
         return true;
@@ -121 +137 @@
 
         unset( $this->registered_patterns[ $pattern_name ] );
+        unset( $this->registered_patterns_outside_init[ $pattern_name ] );
 
         return true;
@@ -146 +163 @@
      * @since 5.5.0
      *
+     * @param bool $outside_init_only Return only patterns registered outside the `init` action.
      * @return array[] Array of arrays containing the registered block patterns properties,
      *                 and per style.
      */
-    public function get_all_registered() {
-        return array_values( $this->registered_patterns );
+    public function get_all_registered( $outside_init_only = false ) {
+        return array_values(
+            $outside_init_only
+                ? $this->registered_patterns_outside_init
+                : $this->registered_patterns
+        );
     }