Changeset 57020 for branches/6.4/tests/phpunit/tests/block-template.php

Timestamp:

10/27/2023 06:34:11 PM (12 months ago)

Author:

flixos90

Message:

Themes: Skip wrapping block template for singular content with a main query loop when the template was injected from outside the current theme.

As a follow up to [56507], this fixes a bug that could occur for instance when plugins hijack the block template detection process to inject their own block template with entirely custom logic.

Props afragen, hellofromTonya, costdev, mukesh27, huzaifaalmesbah, flixos90.
Merges [57019] to the 6.4 branch.
Fixes #59736.
See #58154.

Location:

branches/6.4

Files:

• . (modified) (1 prop)
• tests/phpunit/tests/block-template.php (modified) (6 diffs)

branches/6.4/tests/phpunit/tests/block-template.php

@@ -20 +20 @@
 
     public function tear_down() {
-        global $_wp_current_template_content;
-        unset( $_wp_current_template_content );
+        global $_wp_current_template_id, $_wp_current_template_content;
+        unset( $_wp_current_template_id, $_wp_current_template_content );
 
         parent::tear_down();
@@ -194 +194 @@
      *
      * @ticket 58154
+     * @ticket 59736
      * @covers ::get_the_block_template_html
      */
     public function test_get_the_block_template_html_enforces_singular_query_loop() {
-        global $_wp_current_template_content, $wp_query, $wp_the_query;
+        global $_wp_current_template_id, $_wp_current_template_content, $wp_query, $wp_the_query;
 
         // Register test block to log `in_the_loop()` results.
@@ -208 +209 @@
         $wp_the_query = $wp_query;
 
+        // Force a template ID that is for the current stylesheet.
+        $_wp_current_template_id = get_stylesheet() . '//single';
         // Use block template that just renders post title and the above test block.
         $_wp_current_template_content = '<!-- wp:post-title /--><!-- wp:test/in-the-loop-logger /-->';
@@ -228 +231 @@
      */
     public function test_get_the_block_template_html_does_not_generally_enforce_loop() {
-        global $_wp_current_template_content, $wp_query, $wp_the_query;
+        global $_wp_current_template_id, $_wp_current_template_content, $wp_query, $wp_the_query;
 
         // Register test block to log `in_the_loop()` results.
@@ -248 +251 @@
         );
         $wp_the_query = $wp_query;
+
+        // Force a template ID that is for the current stylesheet.
+        $_wp_current_template_id = get_stylesheet() . '//home';
 
         /*
@@ -278 +284 @@
 
     /**
+     * Tests that `get_the_block_template_html()` does not start the main query loop when on a template that is not from the current theme.
+     *
+     * @ticket 58154
+     * @ticket 59736
+     * @covers ::get_the_block_template_html
+     */
+    public function test_get_the_block_template_html_skips_singular_query_loop_when_non_theme_template() {
+        global $_wp_current_template_id, $_wp_current_template_content, $wp_query, $wp_the_query;
+
+        // Register test block to log `in_the_loop()` results.
+        $in_the_loop_logs = array();
+        $this->register_in_the_loop_logger_block( $in_the_loop_logs );
+
+        // Set main query to single post.
+        $post_id      = self::factory()->post->create( array( 'post_title' => 'A single post' ) );
+        $wp_query     = new WP_Query( array( 'p' => $post_id ) );
+        $wp_the_query = $wp_query;
+
+        // Force a template ID that is not for the current stylesheet.
+        $_wp_current_template_id = 'some-plugin-slug//single';
+        // Use block template that just renders post title and the above test block.
+        $_wp_current_template_content = '<!-- wp:post-title /--><!-- wp:test/in-the-loop-logger /-->';
+
+        $output = get_the_block_template_html();
+        $this->unregister_in_the_loop_logger_block();
+        $this->assertSame( array( false ), $in_the_loop_logs, 'Main query loop was triggered despite a custom block template outside the current theme being used' );
+    }
+
+    /**
      * @ticket 58319
      *