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

Jump to bottom

Patterns: Allow for filtering of block patterns by source #4697

Closed
wants to merge 6 commits into from
Closed

Patterns: Allow for filtering of block patterns by source #4697

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
49d01ac
Changes from https://github.com/WordPress/wordpress-develop/pull/4655
aaronrobertshaw Jun 26, 2023
9a6553d
Tweak comment
aaronrobertshaw Jun 26, 2023
a65767a
Revert change to path
talldan Jun 26, 2023
679ba66
Remove added in 6.3.0 comments
talldan Jun 26, 2023
69af6b2
Try updating tests
talldan Jun 26, 2023
567d5f8
Request source field in get_items test
aaronrobertshaw Jun 26, 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
14 changes: 10 additions & 4 deletions src/wp-includes/block-patterns.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* Registers the core block patterns and categories.
*
* @since 5.5.0
* @since 6.3.0 Added source to core block patterns.
* @access private
*/
function _register_core_block_patterns_and_categories() {
Expand All @@ -29,10 +30,9 @@ function _register_core_block_patterns_and_categories() {
);

foreach ( $core_block_patterns as $core_block_pattern ) {
register_block_pattern(
'core/' . $core_block_pattern,
require __DIR__ . '/block-patterns/' . $core_block_pattern . '.php'
);
$pattern = require ABSPATH . WPINC . '/block-patterns/' . $core_block_pattern . '.php';
Copy link
Contributor

@talldan talldan Jun 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I think the path was only changed in the gutenberg plugin because the plugin is in a different directory.

No need to bring this change over to core.

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for explaining that 👍

I did a brief check elsewhere in core and saw similar approaches in defining required paths, so mistakenly brought that over.

$pattern['source'] = 'core'; // Added in 6.3.0.
Copy link
Contributor

Choose a reason for hiding this comment

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

The 'Added in 6.3.0' comments are useful in the Gutenberg plugin, but not so useful here, so I think they can be removed.

register_block_pattern( 'core/' . $core_block_pattern, $pattern );
}
}

Expand Down Expand Up @@ -190,6 +190,7 @@ function wp_normalize_remote_block_pattern( $pattern ) {
* @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).
* @since 6.3.0 Add 'pattern-directory/core' to the pattern's source.
aaronrobertshaw 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 @@ -224,6 +225,7 @@ function _load_remote_block_patterns( $deprecated = null ) {
$patterns = $response->get_data();

foreach ( $patterns as $pattern ) {
$pattern['source'] = 'pattern-directory/core'; // Added in 6.3.0.
$normalized_pattern = wp_normalize_remote_block_pattern( $pattern );
$pattern_name = 'core/' . sanitize_title( $normalized_pattern['title'] );
register_block_pattern( $pattern_name, $normalized_pattern );
Expand All @@ -237,6 +239,7 @@ function _load_remote_block_patterns( $deprecated = null ) {
* @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).
* @since 6.3.0 Add 'pattern-directory/featured' to the pattern's 'source'.
*/
function _load_remote_featured_patterns() {
$supports_core_patterns = get_theme_support( 'core-block-patterns' );
Expand All @@ -258,6 +261,7 @@ function _load_remote_featured_patterns() {
$patterns = $response->get_data();
$registry = WP_Block_Patterns_Registry::get_instance();
foreach ( $patterns as $pattern ) {
$pattern['source'] = 'pattern-directory/featured'; // Added in 6.3.0.
$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.
Expand All @@ -275,6 +279,7 @@ function _load_remote_featured_patterns() {
* @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).
* @since 6.3.0 Add 'pattern-directory/theme' to the pattern's 'source'.
* @access private
*/
function _register_remote_theme_patterns() {
Expand All @@ -301,6 +306,7 @@ function _register_remote_theme_patterns() {
$patterns = $response->get_data();
$patterns_registry = WP_Block_Patterns_Registry::get_instance();
foreach ( $patterns as $pattern ) {
$pattern['source'] = 'pattern-directory/theme'; // Added in 6.3.0.
$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.
Expand Down
17 changes: 17 additions & 0 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@ protected function migrate_pattern_categories( $pattern ) {
* Prepare a raw block pattern before it gets output in a REST API response.
*
* @since 6.0.0
* @since 6.3.0 Added `source` property.
*
* @param array $item Raw pattern as registered, before any changes.
* @param WP_REST_Request $request Request object.
Expand All @@ -174,6 +175,7 @@ public function prepare_item_for_response( $item, $request ) {
'blockTypes' => 'block_types',
'postTypes' => 'post_types',
'templateTypes' => 'template_types',
'source' => 'source',
);
$data = array();
foreach ( $keys as $item_key => $rest_key ) {
Expand All @@ -192,6 +194,7 @@ public function prepare_item_for_response( $item, $request ) {
* Retrieves the block pattern schema, conforming to JSON Schema.
*
* @since 6.0.0
* @since 6.3.0 Added `source` property.
*
* @return array Item schema data.
*/
Expand Down Expand Up @@ -267,6 +270,20 @@ public function get_item_schema() {
'readonly' => true,
'context' => array( 'view', 'edit', 'embed' ),
),
'source' => array(
'description' => __( 'Where the pattern comes from e.g. core' ),
'type' => 'string',
'readonly' => true,
'context' => array( 'view', 'edit', 'embed' ),
'enum' => array(
'core',
'plugin',
'theme',
'pattern-directory/core',
'pattern-directory/theme',
'pattern-directory/featured',
),
),
),
);

Expand Down