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

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

Built from https://develop.svn.wordpress.org/trunk@55234


git-svn-id: http://core.svn.wordpress.org/trunk@54767 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/block-patterns.php

@@ -158,11 +158,38 @@ function _register_core_block_patterns_and_categories() {
 	);
 }
 
+/**
+ * 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.
  */
@@ -196,9 +223,10 @@ function _load_remote_block_patterns( $deprecated = null ) {
 		}
 		$patterns = $response->get_data();
 
-		foreach ( $patterns as $settings ) {
+		foreach ( $patterns as $pattern ) {
-			$pattern_name = 'core/' . sanitize_title( $settings['title'] );
+			$normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
-			register_block_pattern( $pattern_name, (array) $settings );
+			$pattern_name       = 'core/' . sanitize_title( $normalized_pattern['title'] );
+			register_block_pattern( $pattern_name, $normalized_pattern );
 		}
 	}
 }
@@ -207,6 +235,8 @@ function _load_remote_block_patterns( $deprecated = null ) {
  * Register `Featured` (category) patterns from wordpress.org/patterns.
  *
  * @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() {
 	$supports_core_patterns = get_theme_support( 'core-block-patterns' );
@@ -226,14 +256,14 @@ function _load_remote_featured_patterns() {
 		return;
 	}
 	$patterns = $response->get_data();
-
-	foreach ( $patterns as $pattern ) {
-		$pattern_name = sanitize_title( $pattern['title'] );
 	$registry = WP_Block_Patterns_Registry::get_instance();
+	foreach ( $patterns as $pattern ) {
+		$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 );
 		}
 	}
 }
@@ -243,6 +273,8 @@ function _load_remote_featured_patterns() {
  * `theme.json` file.
  *
  * @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
  */
 function _register_remote_theme_patterns() {
@@ -269,11 +301,12 @@ function _register_remote_theme_patterns() {
 	$patterns          = $response->get_data();
 	$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 );
 		}
 	}
 }

wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

@@ -202,6 +202,7 @@ class WP_REST_Pattern_Directory_Controller extends WP_REST_Controller {
 			'keywords'       => array_map( 'sanitize_text_field', explode( ',', $raw_pattern->meta->wpop_keywords ) ),
 			'description'    => sanitize_text_field( $raw_pattern->meta->wpop_description ),
 			'viewport_width' => absint( $raw_pattern->meta->wpop_viewport_width ),
+			'block_types'    => array_map( 'sanitize_text_field', $raw_pattern->meta->wpop_block_types ),
 		);
 
 		$prepared_pattern = $this->add_additional_fields_to_object( $prepared_pattern, $request );
@@ -224,6 +225,7 @@ class WP_REST_Pattern_Directory_Controller extends WP_REST_Controller {
 	 * Retrieves the block pattern's schema, conforming to JSON Schema.
 	 *
 	 * @since 5.8.0
+	 * @since 6.2.0 Added `'block_types'` to schema.
 	 *
 	 * @return array Item schema data.
 	 */
@@ -286,6 +288,14 @@ class WP_REST_Pattern_Directory_Controller extends WP_REST_Controller {
 					'type'        => 'integer',
 					'context'     => array( 'view', 'edit', 'embed' ),
 				),
+
+				'block_types'    => array(
+					'description' => __( 'The block types which can use this pattern.' ),
+					'type'        => 'array',
+					'uniqueItems' => true,
+					'items'       => array( 'type' => 'string' ),
+					'context'     => array( 'view', 'embed' ),
+				),
 			),
 		);
 

wp-includes/version.php

@@ -16,7 +16,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '6.2-alpha-55233';
+$wp_version = '6.2-alpha-55234';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.