Changeset 54184 for trunk/tests/phpunit/tests/block-template-utils.php

Timestamp:

09/15/2022 10:26:28 PM (3 years ago)

Author:

hellofromTonya

Message:

Editor: Fix get_block_templates() to get templates for a post type.

When a post type is passed to get_block_templates() in the query, return only the templates that match that post type.

Fixes an issue where:

• when a block template provided by a theme has been edited by the user
• and that template has specific defined postTypes
• but after editing, the template was available for all post types.

Follow-up to [52062].

Props aljullu, bernhard-reiter, hellofromTonya.
Fixes #55881.

File:

• trunk/tests/phpunit/tests/block-template-utils.php (modified) (4 diffs)

trunk/tests/phpunit/tests/block-template-utils.php

@@ -13 +13 @@
 class Tests_Block_Template_Utils extends WP_UnitTestCase {
     private static $post;
+    private static $custom_single_post_template_post;
     private static $template_part_post;
     private static $test_theme = 'block-theme';
@@ -51 +52 @@
         wp_set_post_terms( self::$post->ID, self::$test_theme, 'wp_theme' );
 
+        // Set up template post.
+        $args                                   = array(
+            'post_type'    => 'wp_template',
+            'post_name'    => 'custom-single-post-template',
+            'post_title'   => 'Custom Single Post template (modified)',
+            'post_content' => 'Content',
+            'post_excerpt' => 'Description of custom single post template',
+            'tax_input'    => array(
+                'wp_theme' => array(
+                    self::$test_theme,
+                ),
+            ),
+        );
+        self::$custom_single_post_template_post = self::factory()->post->create_and_get( $args );
+        wp_set_post_terms( self::$custom_single_post_template_post->ID, self::$test_theme, 'wp_theme' );
+
         // Set up template part post.
         $template_part_args       = array(
@@ -79 +96 @@
     public static function wpTearDownAfterClass() {
         wp_delete_post( self::$post->ID );
+        wp_delete_post( self::$custom_single_post_template_post->ID );
     }
 
@@ -320 +338 @@
         );
         */
+    }
+
+    /**
+     * @dataProvider data_get_block_template_should_respect_posttypes_property
+     * @ticket 55881
+     * @covers ::get_block_templates
+     *
+     * @param string $post_type Post type for query.
+     * @param array  $expected  Expected template IDs.
+     */
+    public function test_get_block_template_should_respect_posttypes_property( $post_type, $expected ) {
+        $templates = get_block_templates( array( 'post_type' => $post_type ) );
+
+        $this->assertSame(
+            $expected,
+            $this->get_template_ids( $templates )
+        );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_get_block_template_should_respect_posttypes_property() {
+        return array(
+            'post' => array(
+                'post_type' => 'post',
+                'expected'  => array(
+                    'block-theme//my_template',
+                    'block-theme//custom-single-post-template',
+                ),
+            ),
+            'page' => array(
+                'post_type' => 'page',
+                'expected'  => array(
+                    'block-theme//my_template',
+                    'block-theme//page-home',
+                ),
+            ),
+        );
+    }
+
+    /**
+     * Gets the template IDs from the given array.
+     *
+     * @param object[] $templates Array of template objects to parse.
+     * @return string[] The template IDs.
+     */
+    private function get_template_ids( $templates ) {
+        return array_map(
+            static function( $template ) {
+                return $template->id;
+            },
+            $templates
+        );
     }