Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support the blockTypes and viewport_width props for remote patterns fetched from Pattern Directory #3967

Closed
wants to merge 6 commits into from
Closed

Support the blockTypes and viewport_width props for remote patterns fetched from Pattern Directory #3967

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e4b429e
Support the `blockTypes` and `viewport_width` props for remote patter…
ntsekouras Feb 2, 2023
1a0faab
DocBlock improvements
hellofromtonya Feb 2, 2023
3a4bc08
Remove unneeded type cast
hellofromtonya Feb 2, 2023
cf2cae5
Doc change of adding block_types to schema
hellofromtonya Feb 2, 2023
b271369
rename to `_normalize_remote_block_pattern`
ntsekouras Feb 5, 2023
6f39a68
Use wp_ prefix instead of underscore prefix.
felixarntz Feb 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 35 additions & 9 deletions src/wp-includes/block-patterns.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,11 +158,33 @@ function _register_core_block_patterns_and_categories() {
);
}

/**
* Normalize the pattern from the API (snake_case) to the format expected by `register_block_pattern` (camelCase).
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
*
* @since 6.2.0
*
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
* @param array $pattern Pattern as returned from the Pattern Directory API.
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
*/
function _normalize_remote_pattern( $pattern ) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A search of the wp.org repo shows:

The name follows the naming patterns in this file.

Note: There could be a risk for a naming conflict in the wild.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open to any suggestions :)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would _normalize_remote_block_pattern() help? The other functions in this file refer to "block" and/or "theme" in their names. (Also, there are 0 plugins and 0 themes using this.)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I renamed to _normalize_remote_block_pattern.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #3967 (review), we should not be using underscore prefixes in Core. This is something that I was already advised by seasoned committers several years ago. While occasionally it gets overlooked, it's not a good practice. The recommendation is to simply mark the function with @access private.

I've updated this in 6f39a68.

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).
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
*
* @param WP_Screen $deprecated Unused. Formerly the screen that the current request was triggered from.
*/
Expand Down Expand Up @@ -196,9 +218,10 @@ function _load_remote_block_patterns( $deprecated = null ) {
}
$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 = _normalize_remote_pattern( $pattern );
$pattern_name = 'core/' . sanitize_title( $normalized_pattern['title'] );
register_block_pattern( $pattern_name, (array) $normalized_pattern );
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Expand All @@ -207,6 +230,7 @@ function _load_remote_block_patterns( $deprecated = null ) {
* Register `Featured` (category) patterns from wordpress.org/patterns.
*
* @since 5.9.0
* @since 6.2.0 Normalize the pattern from the API (snake_case) to the format expected by `register_block_pattern` (camelCase).
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
*/
function _load_remote_featured_patterns() {
$supports_core_patterns = get_theme_support( 'core-block-patterns' );
Expand All @@ -226,14 +250,14 @@ function _load_remote_featured_patterns() {
return;
}
$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 = _normalize_remote_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, (array) $normalized_pattern );
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Expand All @@ -243,6 +267,7 @@ function _load_remote_featured_patterns() {
* `theme.json` file.
*
* @since 6.0.0
* @since 6.2.0 Normalize the pattern from the API (snake_case) to the format expected by `register_block_pattern` (camelCase).
hellofromtonya marked this conversation as resolved.
Show resolved Hide resolved
* @access private
*/
function _register_remote_theme_patterns() {
Expand All @@ -269,11 +294,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 = _normalize_remote_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, (array) $normalized_pattern );
}
}
}
Expand Down
11 changes: 10 additions & 1 deletion src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public function get_items( $request ) {
'search' => true,
'slug' => true,
);
$query_args = array_intersect_key( $request->get_params(), $valid_query_args );
$query_args = array_intersect_key( $request->get_params(), $valid_query_args );

$query_args['locale'] = get_user_locale();
$query_args['wp-version'] = $wp_version; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable -- it's defined in `version.php` above.
Expand Down Expand Up @@ -202,6 +202,7 @@ public function prepare_item_for_response( $item, $request ) {
'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 );
Expand Down Expand Up @@ -286,6 +287,14 @@ public function get_item_schema() {
'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' ),
),
),
);

Expand Down
9 changes: 6 additions & 3 deletions tests/phpunit/data/blocks/pattern-directory/browse-all.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"spay_email": "",
"wpop_description": "A heading preceded by a chapter number, and followed by a paragraph.",
"wpop_keywords": "blog post",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": [ "core/heading" ]
},
"category_slugs": [ "text" ],
"keyword_slugs": [ "core" ],
Expand All @@ -27,7 +28,8 @@
"spay_email": "",
"wpop_description": "A large hero section with an example background image and a heading in the center.",
"wpop_keywords": "header, hero",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "header" ],
"keyword_slugs": [ "core" ],
Expand All @@ -44,7 +46,8 @@
"spay_email": "",
"wpop_description": "A large hero section with a bright gradient background, a big heading and a filled button.",
"wpop_keywords": "call to action, hero section",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "header" ],
"keyword_slugs": [ "core" ],
Expand Down
6 changes: 4 additions & 2 deletions tests/phpunit/data/blocks/pattern-directory/browse-category-2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"spay_email": "",
"wpop_description": "Three filled buttons with rounded corners, side by side.",
"wpop_keywords": "",
"wpop_viewport_width": 600
"wpop_viewport_width": 600,
"wpop_block_types": []
},
"category_slugs": [ "buttons" ],
"keyword_slugs": [ "core" ],
Expand All @@ -27,7 +28,8 @@
"spay_email": "",
"wpop_description": "Two buttons, one filled and one outlined, side by side.",
"wpop_keywords": "",
"wpop_viewport_width": 500
"wpop_viewport_width": 500,
"wpop_block_types": []
},
"category_slugs": [ "buttons" ],
"keyword_slugs": [ "core" ],
Expand Down
9 changes: 6 additions & 3 deletions tests/phpunit/data/blocks/pattern-directory/browse-keyword-11.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"spay_email": "",
"wpop_description": "A heading preceded by a chapter number, and followed by a paragraph.",
"wpop_keywords": "",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "text" ],
"keyword_slugs": [ "core" ],
Expand All @@ -27,7 +28,8 @@
"spay_email": "",
"wpop_description": "A large hero section with an example background image and a heading in the center.",
"wpop_keywords": "",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "header" ],
"keyword_slugs": [ "core" ],
Expand All @@ -44,7 +46,8 @@
"spay_email": "",
"wpop_description": "A large hero section with a bright gradient background, a big heading and a filled button.",
"wpop_keywords": "",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "header" ],
"keyword_slugs": [ "core" ],
Expand Down
12 changes: 8 additions & 4 deletions tests/phpunit/data/blocks/pattern-directory/search-button.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
"spay_email": "",
"wpop_description": "A large hero section with a bright gradient background, a big heading and a filled button.",
"wpop_keywords": "",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "header" ],
"keyword_slugs": [ "core" ],
Expand All @@ -27,7 +28,8 @@
"spay_email": "",
"wpop_description": "Three small columns of text, each with an outlined button with rounded corners at the bottom.",
"wpop_keywords": "",
"wpop_viewport_width": 1000
"wpop_viewport_width": 1000,
"wpop_block_types": []
},
"category_slugs": [ "columns" ],
"keyword_slugs": [ "core" ],
Expand All @@ -44,7 +46,8 @@
"spay_email": "",
"wpop_description": "Three filled buttons with rounded corners, side by side.",
"wpop_keywords": "",
"wpop_viewport_width": 600
"wpop_viewport_width": 600,
"wpop_block_types": []
},
"category_slugs": [ "buttons" ],
"keyword_slugs": [ "core" ],
Expand All @@ -61,7 +64,8 @@
"spay_email": "",
"wpop_description": "Two buttons, one filled and one outlined, side by side.",
"wpop_keywords": "",
"wpop_viewport_width": 500
"wpop_viewport_width": 500,
"wpop_block_types": []
},
"category_slugs": [ "buttons" ],
"keyword_slugs": [ "core" ],
Expand Down