Changeset 55234 for trunk/src/wp-includes/block-patterns.php

Timestamp:

02/06/2023 07:38:08 PM (3 years ago)

Author:

flixos90

Message:

Editor: Support the block_types and viewport_width props for remote patterns fetched from Pattern Directory.

Props ntsekouras, ironprogrammer, hellofromtonya, flixos90.
Fixes #57611.

File:

• trunk/src/wp-includes/block-patterns.php (modified) (6 diffs)

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

@@ -160 +160 @@
 
 /**
+ * Normalize the pattern properties to camelCase.
+ *
+ * The API's format is snake_case, `register_block_pattern()` expects camelCase.
+ *
+ * @since 6.2.0
+ * @access private
+ *
+ * @param array $pattern Pattern as returned from the Pattern Directory API.
+ * @return array Normalized pattern.
+ */
+function wp_normalize_remote_block_pattern( $pattern ) {
+    if ( isset( $pattern['block_types'] ) ) {
+        $pattern['blockTypes'] = $pattern['block_types'];
+        unset( $pattern['block_types'] );
+    }
+
+    if ( isset( $pattern['viewport_width'] ) ) {
+        $pattern['viewportWidth'] = $pattern['viewport_width'];
+        unset( $pattern['viewport_width'] );
+    }
+
+    return (array) $pattern;
+}
+
+/**
  * Register Core's official patterns from wordpress.org/patterns.
  *
  * @since 5.8.0
  * @since 5.9.0 The $current_screen argument was removed.
+ * @since 6.2.0 Normalize the pattern from the API (snake_case) to the
+ *              format expected by `register_block_pattern` (camelCase).
  *
  * @param WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.
@@ -197 +224 @@
         $patterns = $response->get_data();
 
-        foreach ( $patterns as $settings ) {
-            $pattern_name = 'core/' . sanitize_title( $settings['title'] );
-            register_block_pattern( $pattern_name, (array) $settings );
+        foreach ( $patterns as $pattern ) {
+            $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
+            $pattern_name       = 'core/' . sanitize_title( $normalized_pattern['title'] );
+            register_block_pattern( $pattern_name, $normalized_pattern );
         }
     }
@@ -208 +236 @@
  *
  * @since 5.9.0
+ * @since 6.2.0 Normalized the pattern from the API (snake_case) to the
+ *              format expected by `register_block_pattern()` (camelCase).
  */
 function _load_remote_featured_patterns() {
@@ -227 +257 @@
     }
     $patterns = $response->get_data();
-
+    $registry = WP_Block_Patterns_Registry::get_instance();
     foreach ( $patterns as $pattern ) {
-        $pattern_name = sanitize_title( $pattern['title'] );
-        $registry     = WP_Block_Patterns_Registry::get_instance();
+        $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
+        $pattern_name       = sanitize_title( $normalized_pattern['title'] );
         // Some patterns might be already registered as core patterns with the `core` prefix.
         $is_registered = $registry->is_registered( $pattern_name ) || $registry->is_registered( "core/$pattern_name" );
         if ( ! $is_registered ) {
-            register_block_pattern( $pattern_name, (array) $pattern );
+            register_block_pattern( $pattern_name, $normalized_pattern );
         }
     }
@@ -244 +274 @@
  *
  * @since 6.0.0
+ * @since 6.2.0 Normalized the pattern from the API (snake_case) to the
+ *              format expected by `register_block_pattern()` (camelCase).
  * @access private
  */
@@ -270 +302 @@
     $patterns_registry = WP_Block_Patterns_Registry::get_instance();
     foreach ( $patterns as $pattern ) {
-        $pattern_name = sanitize_title( $pattern['title'] );
+        $normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
+        $pattern_name       = sanitize_title( $normalized_pattern['title'] );
         // Some patterns might be already registered as core patterns with the `core` prefix.
         $is_registered = $patterns_registry->is_registered( $pattern_name ) || $patterns_registry->is_registered( "core/$pattern_name" );
         if ( ! $is_registered ) {
-            register_block_pattern( $pattern_name, (array) $pattern );
+            register_block_pattern( $pattern_name, $normalized_pattern );
         }
     }