Changeset 56063

Timestamp:

06/27/2023 11:11:02 AM (15 months ago)

Author:

isabel_brison

Message:

Editor: allow filtering block patterns by source.

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.

Location:

trunk

Files:

• src/wp-includes/block-patterns.php (modified) (8 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php (modified) (6 diffs)

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

@@ -13 +13 @@
  *
  * @since 5.5.0
+ * @since 6.3.0 Added source to core block patterns.
  * @access private
  */
@@ -30 +31 @@
 
         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 );
         }
     }
@@ -191 +191 @@
  * @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.
@@ -225 +226 @@
 
         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'] );
@@ -238 +240 @@
  * @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() {
@@ -259 +262 @@
     $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'] );
@@ -276 +280 @@
  * @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
  */
@@ -302 +307 @@
     $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'] );

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php

@@ -156 +156 @@
      *
      * @since 6.0.0
+     * @since 6.3.0 Added `source` property.
      *
      * @param array           $item    Raw pattern as registered, before any changes.
@@ -175 +176 @@
             'postTypes'     => 'post_types',
             'templateTypes' => 'template_types',
+            'source'        => 'source',
         );
         $data   = array();
@@ -193 +195 @@
      *
      * @since 6.0.0
+     * @since 6.3.0 Added `source` property.
      *
      * @return array Item schema data.
@@ -268 +271 @@
                     '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',
+                    ),
+                ),
             ),
         );

trunk/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php

@@ -77 +77 @@
                 'categories'    => array( 'test' ),
                 'templateTypes' => array( 'page' ),
+                'source'        => 'theme',
             )
         );
@@ -87 +88 @@
                 'categories'    => array( 'test' ),
                 'templateTypes' => array( 'single' ),
+                'source'        => 'core',
             )
         );
@@ -96 +98 @@
                 'content'    => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
                 'categories' => array( 'test', 'buttons', 'query' ),
+                'source'     => 'pattern-directory/featured',
             )
         );
@@ -125 +128 @@
 
         $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();
@@ -136 +139 @@
                 'content'        => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
                 'template_types' => array( 'page' ),
+                'source'         => 'theme',
             ),
             $data[0],
@@ -145 +149 @@
                 'content'        => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
                 'template_types' => array( 'single' ),
+                'source'         => 'core',
             ),
             $data[1],