Skip to content

Commit

Permalink
Editor: allow filtering block patterns by source.
Browse files Browse the repository at this point in the history 
Extends the REST API endpoint for block patterns to provide a source attribute that can be used to filter patterns.

Props aaronrobertshaw, mukesh27, talldanwp, ramonopoly.
Fixes 58622.


git-svn-id: https://develop.svn.wordpress.org/trunk@56063 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
@tellthemachines
tellthemachines committed Jun 27, 2023
1 parent 27cee0b commit c27f776
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 5 deletions.
14 changes: 10 additions & 4 deletions src/wp-includes/block-patterns.php
View file
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 __DIR__ . '/block-patterns/' . $core_block_pattern . '.php';
$pattern['source'] = 'core';
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'.
*
* @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';
$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';
$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';
$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
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
7 changes: 6 additions & 1 deletion tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ public static function wpSetUpBeforeClass( $factory ) {
'viewportWidth' => 1440,
'categories' => array( 'test' ),
'templateTypes' => array( 'page' ),
'source' => 'theme',
)
);

Expand All @@ -86,6 +87,7 @@ public static function wpSetUpBeforeClass( $factory ) {
'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
'categories' => array( 'test' ),
'templateTypes' => array( 'single' ),
'source' => 'core',
)
);

Expand All @@ -95,6 +97,7 @@ public static function wpSetUpBeforeClass( $factory ) {
'title' => 'Pattern Three',
'content' => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
'categories' => array( 'test', 'buttons', 'query' ),
'source' => 'pattern-directory/featured',
)
);
}
Expand Down Expand Up @@ -124,7 +127,7 @@ public function test_get_items() {
wp_set_current_user( self::$admin_id );

$request = new WP_REST_Request( 'GET', static::REQUEST_ROUTE );
$request['_fields'] = 'name,content,template_types';
$request['_fields'] = 'name,content,source,template_types';
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();

Expand All @@ -135,6 +138,7 @@ public function test_get_items() {
'name' => 'test/one',
'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
'template_types' => array( 'page' ),
'source' => 'theme',
),
$data[0],
'WP_REST_Block_Patterns_Controller::get_items() should return test/one'
Expand All @@ -144,6 +148,7 @@ public function test_get_items() {
'name' => 'test/two',
'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
'template_types' => array( 'single' ),
'source' => 'core',
),
$data[1],
'WP_REST_Block_Patterns_Controller::get_items() should return test/two'
Expand Down

0 comments on commit c27f776

Please sign in to comment.