Add: Template types to the patterns API.

WordPress · Jan 30, 2023 · ca8fcae · ca8fcae
1 parent b74cfa8
commit ca8fcae
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/src/wp-includes/block-patterns.php b/src/wp-includes/block-patterns.php
@@ -318,6 +318,7 @@ function _register_theme_block_patterns() {
 		'blockTypes'    => 'Block Types',
 		'postTypes'     => 'Post Types',
 		'inserter'      => 'Inserter',
+		'templateTypes' => 'Template Types',
 	);
 
 	/*
@@ -388,7 +389,7 @@ function _register_theme_block_patterns() {
 					}
 
 					// 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(
 								preg_split(

diff --git a/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php b/src/wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php
@@ -173,6 +173,7 @@ public function prepare_item_for_response( $item, $request ) {
 			'keywords'      => 'keywords',
 			'content'       => 'content',
 			'inserter'      => 'inserter',
+			'templateTypes' => 'template_types',
 		);
 		$data   = array();
 		foreach ( $keys as $item_key => $rest_key ) {
@@ -248,6 +249,12 @@ public function get_item_schema() {
 					'readonly'    => true,
 					'context'     => array( 'view', 'edit', 'embed' ),
 				),
+				'template_types' => array(
+					'description' => __( 'An array of template types where the pattern fits.', 'gutenberg' ),
+					'type'        => 'array',
+					'readonly'    => true,
+					'context'     => array( 'view', 'edit', 'embed' ),
+				),
 				'content'        => array(
 					'description' => __( 'The pattern content.' ),
 					'type'        => 'string',

diff --git a/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php b/tests/phpunit/tests/rest-api/wpRestBlockPatternsController.php
@@ -81,24 +81,26 @@ public static function wpSetUpBeforeClass( $factory ) {
 				'categories'    => array( 'test' ),
 				'viewportWidth' => 1440,
 				'content'       => '<!-- wp:heading {"level":1} --><h1>One</h1><!-- /wp:heading -->',
+				'templateTypes' => array( 'page' ),
 			)
 		);
 
 		$test_registry->register(
 			'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' ),
 			)
 		);
 
 		$test_registry->register(
 			'test/three',
 			array(
-				'title'      => 'Pattern Three',
-				'categories' => array( 'test', 'buttons', 'query' ),
-				'content'    => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
+				'title'         => 'Pattern Three',
+				'categories'    => array( 'test', 'buttons', 'query' ),
+				'content'       => '<!-- wp:paragraph --><p>Three</p><!-- /wp:paragraph -->',
 			)
 		);
 	}
@@ -128,24 +130,26 @@ 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';
+		$request['_fields'] = 'name,content,template_types';
 		$response           = rest_get_server()->dispatch( $request );
 		$data               = $response->get_data();
 
 		$this->assertIsArray( $data, 'WP_REST_Block_Patterns_Controller::get_items() should return an array' );
 		$this->assertGreaterThanOrEqual( 2, count( $data ), 'WP_REST_Block_Patterns_Controller::get_items() should return at least 2 items' );
 		$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],
 			'WP_REST_Block_Patterns_Controller::get_items() should return test/one'
 		);
 		$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],
 			'WP_REST_Block_Patterns_Controller::get_items() should return test/two'