Changeset 61469 for trunk/tests/phpunit/tests/block-template.php

Timestamp:

01/11/2026 06:34:57 AM (2 months ago)

Author:

westonruter

Message:

Themes: Use WP_HTML_Tag_Processor to insert the block template skip link instead of JavaScript.

• The skip link now works when JavaScript is turned off.
• By removing the script, the amount of JavaScript sent to the client is reduced for a very marginal performance improvement.
• A new wp-block-template-skip-link stylesheet is registered, with minification and path data for inlining.
• The CSS for the skip link now has an RTL version generated, although it is not yet served when the styles are inlined. See #61625.
• The wp_enqueue_block_template_skip_link() function now exclusively enqueues the stylesheet since the script is removed.
• For backwards-compatibility, the skip link will continue to be omitted if the_block_template_skip_link() is unhooked from the wp_footer action or wp_enqueue_block_template_skip_link() is unhooked from wp_enqueue_scripts.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10676

Follow-up to [56932], [51003].

Props rutviksavsani, westonruter, dmsnell, whiteshadow01, Slieptsov.
See #59505, #53176.
Fixes #64361.

File:

• trunk/tests/phpunit/tests/block-template.php (modified) (1 diff)

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

@@ -313 +313 @@
 
     /**
+     * Tests that `get_the_block_template_html()` adds a skip link when a MAIN element is present.
+     *
+     * @ticket 64361
+     * @covers ::get_the_block_template_html
+     */
+    public function test_get_the_block_template_html_adds_skip_link_when_main_present() {
+        global $_wp_current_template_id, $_wp_current_template_content;
+
+        $_wp_current_template_id      = get_stylesheet() . '//index';
+        $_wp_current_template_content = '<main>Content</main>';
+
+        $processor = new WP_HTML_Tag_Processor( get_the_block_template_html() );
+        $this->assertTrue(
+            $processor->next_tag(
+                array(
+                    'tag_name'   => 'A',
+                    'class_name' => 'skip-link',
+                )
+            ),
+            'Expected skip link was not added to the block template HTML.'
+        );
+        $this->assertSame( 'wp-skip-link', $processor->get_attribute( 'id' ), 'Unexpected ID on skip link.' );
+        $this->assertTrue( $processor->has_class( 'screen-reader-text' ), 'Expected "screen-reader-text" class on skip link.' );
+    }
+
+    /**
+     * Tests that `get_the_block_template_html()` does not add a skip link when the skip-link action is unhooked.
+     *
+     * @ticket 64361
+     * @covers ::get_the_block_template_html
+     *
+     * @dataProvider data_provider_skip_link_actions
+     */
+    public function test_get_the_block_template_html_does_not_add_skip_link_when_action_unhooked( string $action, string $callback ) {
+        global $_wp_current_template_id, $_wp_current_template_content;
+
+        $_wp_current_template_id      = get_stylesheet() . '//index';
+        $_wp_current_template_content = '<main>Content</main>';
+
+        remove_action( $action, $callback );
+
+        $processor = new WP_HTML_Tag_Processor( get_the_block_template_html() );
+        $this->assertFalse(
+            $processor->next_tag(
+                array(
+                    'tag_name'   => 'A',
+                    'class_name' => 'skip-link',
+                )
+            ),
+            'Unexpected skip link was added to the block template HTML when the action was unhooked.'
+        );
+    }
+
+    /**
+     * Data provider for test_get_the_block_template_html_does_not_add_skip_link_when_action_unhooked.
+     *
+     * @return array<string, array<string, string>>
+     */
+    public function data_provider_skip_link_actions(): array {
+        return array(
+            'the_block_template_skip_link'        => array(
+                'action'   => 'wp_footer',
+                'callback' => 'the_block_template_skip_link',
+            ),
+            'wp_enqueue_block_template_skip_link' => array(
+                'action'   => 'wp_enqueue_scripts',
+                'callback' => 'wp_enqueue_block_template_skip_link',
+            ),
+        );
+    }
+
+    /**
      * @ticket 58319
      *