Changeset 55168

Timestamp:

01/31/2023 04:47:58 PM (2 years ago)

Author:

jorgefilipecosta

Message:

Add: Template types to the patterns API.

Backports ​https://github.com/WordPress/gutenberg/pull/45814 into the core.
This commit adds a new templateType property to the patterns registration API.
This property allows a pattern to specify which template it makes sense on, e.g.: 404, single-post, single-product, category.

Props youknowriad, ntsekouras,
spacedmonkey.

Location:

trunk

Files:

• src/wp-includes/block-patterns.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php (modified) (5 diffs)

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

@@ -303 +303 @@
  *   - Block Types      (comma-separated values)
  *   - Post Types       (comma-separated values)
+ *   - Template Types   (comma-separated values)
  *   - Inserter         (yes/no)
  *
@@ -319 +320 @@
         'postTypes'     => 'Post Types',
         'inserter'      => 'Inserter',
+        'templateTypes' => 'Template Types',
     );
 
@@ -389 +391 @@
 
                     // For properties of type array, parse data as comma-separated.
-                    foreach ( array( 'categories', 'keywords', 'blockTypes', 'postTypes' ) as $property ) {
+                    foreach ( array( 'categories', 'keywords', 'blockTypes', 'postTypes', 'templateTypes' ) as $property ) {
                         if ( ! empty( $pattern_data[ $property ] ) ) {
                             $pattern_data[ $property ] = array_filter(

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

@@ -174 +174 @@
             'content'       => 'content',
             'inserter'      => 'inserter',
+            'templateTypes' => 'template_types',
         );
         $data   = array();
@@ -249 +250 @@
                     'context'     => array( 'view', 'edit', 'embed' ),
                 ),
+                'template_types' => array(
+                    'description' => __( 'An array of template types where the pattern fits.' ),
+                    'type'        => 'array',
+                    'readonly'    => true,
+                    'context'     => array( 'view', 'edit', 'embed' ),
+                ),
                 'content'        => array(
                     'description' => __( 'The pattern content.' ),

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

@@ -82 +82 @@
                 'viewportWidth' => 1440,
                 'content'       => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+                'templateTypes' => array( 'page' ),
             )
         );
@@ -88 +89 @@
             'test/two',
             array(
-                'title'      => 'Pattern Two',
-                'categories' => array( 'test' ),
-                'content'    => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+                'title'         => 'Pattern Two',
+                'categories'    => array( 'test' ),
+                'content'       => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+                'templateTypes' => array( 'single' ),
             )
         );
@@ -129 +131 @@
 
         $request            = new WP_REST_Request( 'GET', static::REQUEST_ROUTE );
-        $request['_fields'] = 'name,content';
+        $request['_fields'] = 'name,content,template_types';
         $response           = rest_get_server()->dispatch( $request );
         $data               = $response->get_data();
@@ -137 +139 @@
         $this->assertSame(
             array(
-                'name'    => 'test/one',
-                'content' => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+                'name'           => 'test/one',
+                'content'        => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+                'template_types' => array( 'page' ),
             ),
             $data[0],
@@ -145 +148 @@
         $this->assertSame(
             array(
-                'name'    => 'test/two',
-                'content' => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+                'name'           => 'test/two',
+                'content'        => '<!-- wp:paragraph --><p>Two</p><!-- /wp:paragraph -->',
+                'template_types' => array( 'single' ),
             ),
             $data[1],