Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #72489

samueljseay · 2025-10-20T11:52:11Z

What?

Why?

This improves the selective pre-loading of script modules, by using the same approach implemented in core in WordPress/wordpress-develop#10357 utilizing the wp_script_attributes filter to add data-wp-router-options to the script module tags that do need to pre loaded for client-side navigation.

How?

For versions of WP before 6.9 we add our own static registry of modules that should have the data attribute added. For everything else we rely on WordPress/wordpress-develop#10357 which will add script modules to preload based on their interactivity support declared in block.json.

Testing Instructions

Run the Gutenberg plugin on a version of WP core older than 6.9 or prior to Interactivity API: First support for loadOnClientNavigation wordpress-develop#10357
Add a sample page with the core image block and enable the enlarge on click feature of the block. Or create a new interactive block with interactivity enabled in the block.json
Load the page in the front-end, investigate the page source to see the output script module tags
Ensure that the script module tags for the image block or your custom block have the data-wp-router attribute with value { "loadOnClientNavigation": true }

…ttribute to script module

…cise

…pdate/script-module-router-options-attributes

@samueljseay

co-authored: @samueljseay

…-router-options-attributes

luisherranz

Hey Sam, we need to move the compatibility code to the compat folder.

Apart from that, when the WordPress version is 6.9 or higher but Gutenberg is installed, Gutenberg replaces the Core scripts with its own scripts. In that case, we need to make sure that the directive is also being added correctly. That logic needs to be outside of the compat folder, but we can use the new methods introduced in WordPress 6.9.

luisherranz · 2025-10-21T12:18:40Z

lib/client-assets.php

- */
-remove_action( 'wp_enqueue_scripts', 'wp_enqueue_stored_styles' );
-remove_action( 'wp_footer', 'wp_enqueue_stored_styles', 1 );
+if ( version_compare( get_bloginfo( 'version' ), '6.9.0', '<' ) ) {


We need to move this to the compat/wordpress-6.9 folder so that it gets deleted when Gutenberg no longer needs to support versions older than WordPress 6.9.

Gotcha thanks

…en re-registering existing core blocks

github-actions · 2025-10-21T13:39:30Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: luisherranz <luisherranz@git.wordpress.org>
Co-authored-by: samueljseay <samueljseay@git.wordpress.org>
Co-authored-by: DAreRodz <darerodz@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@samueljseay

…ttribute to script module (#72489) * Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module * Use wp_json_encode() * Make gutenberg_script_module_add_router_options_attributes() more concise * Improve phpdoc return tags * Remove compat/wordpress-6.9/script-modules.php * Update backport changelog * (WIP) Use render_block_data to filter all blocks co-authored: @samueljseay * Adjust manual registration of blocks in e2e tests * We should not need any manual registration now. * Update changelog to match new wordpress-develop PR. * Fix merge conflict mistake * Remove redundant white space change * Fix merge conflict mistake * Move conditional code to compat, check for existence of new method when re-registering existing core blocks * Fix typo in code comment. Co-authored-by: Luis Herranz <luisherranz@gmail.com> * Simplify the compatibility check. --------- Co-authored-by: westonruter <westonruter@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: samueljseay <samueljseay@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org>

priethor · 2025-10-22T12:10:04Z

I just cherry-picked this PR to the release/21.9 branch to get it included in the next release: 0926b18

@samueljseay

…ttribute to script module (#72489) * Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module * Use wp_json_encode() * Make gutenberg_script_module_add_router_options_attributes() more concise * Improve phpdoc return tags * Remove compat/wordpress-6.9/script-modules.php * Update backport changelog * (WIP) Use render_block_data to filter all blocks co-authored: @samueljseay * Adjust manual registration of blocks in e2e tests * We should not need any manual registration now. * Update changelog to match new wordpress-develop PR. * Fix merge conflict mistake * Remove redundant white space change * Fix merge conflict mistake * Move conditional code to compat, check for existence of new method when re-registering existing core blocks * Fix typo in code comment. Co-authored-by: Luis Herranz <luisherranz@gmail.com> * Simplify the compatibility check. --------- Co-authored-by: westonruter <westonruter@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: samueljseay <samueljseay@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org>

ellatrix · 2025-11-24T09:25:40Z

Even though these are PHP changes only, and already back ported in core, we should still backport it to the 6.9 branch in Gutenberg so that the test plugin is updated and the e2e tests run fine without GB active.

t-hamano · 2025-11-24T11:27:06Z

For some reason, the automatic cherry-pick to the 6.9 branch isn't happening. I'll try re-adding the label.

t-hamano · 2025-11-24T11:29:50Z

For some reason, the automatic cherry-pick to the 6.9 branch isn't happening. I'll try re-adding the label.

Unfortunately, the CI failed. Maybe it doesn't work for PRs submitted from forked repositories. I'd like to manually create a PR for the backport.

@samueljseay

…ttribute to script module (#72489) * Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module * Use wp_json_encode() * Make gutenberg_script_module_add_router_options_attributes() more concise * Improve phpdoc return tags * Remove compat/wordpress-6.9/script-modules.php * Update backport changelog * (WIP) Use render_block_data to filter all blocks co-authored: @samueljseay * Adjust manual registration of blocks in e2e tests * We should not need any manual registration now. * Update changelog to match new wordpress-develop PR. * Fix merge conflict mistake * Remove redundant white space change * Fix merge conflict mistake * Move conditional code to compat, check for existence of new method when re-registering existing core blocks * Fix typo in code comment. Co-authored-by: Luis Herranz <luisherranz@gmail.com> * Simplify the compatibility check. --------- Co-authored-by: westonruter <westonruter@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: samueljseay <samueljseay@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org>

@samueljseay

…ttribute to script module (#72489) * Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module * Use wp_json_encode() * Make gutenberg_script_module_add_router_options_attributes() more concise * Improve phpdoc return tags * Remove compat/wordpress-6.9/script-modules.php * Update backport changelog * (WIP) Use render_block_data to filter all blocks co-authored: @samueljseay * Adjust manual registration of blocks in e2e tests * We should not need any manual registration now. * Update changelog to match new wordpress-develop PR. * Fix merge conflict mistake * Remove redundant white space change * Fix merge conflict mistake * Move conditional code to compat, check for existence of new method when re-registering existing core blocks * Fix typo in code comment. Co-authored-by: Luis Herranz <luisherranz@gmail.com> * Simplify the compatibility check. --------- Co-authored-by: westonruter <westonruter@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: samueljseay <samueljseay@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org>

@samueljseay

…ttribute to script module (#72489) (#73512) * Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module * Use wp_json_encode() * Make gutenberg_script_module_add_router_options_attributes() more concise * Improve phpdoc return tags * Remove compat/wordpress-6.9/script-modules.php * Update backport changelog * (WIP) Use render_block_data to filter all blocks co-authored: @samueljseay * Adjust manual registration of blocks in e2e tests * We should not need any manual registration now. * Update changelog to match new wordpress-develop PR. * Fix merge conflict mistake * Remove redundant white space change * Fix merge conflict mistake * Move conditional code to compat, check for existence of new method when re-registering existing core blocks * Fix typo in code comment. * Simplify the compatibility check. --------- Co-authored-by: westonruter <westonruter@git.wordpress.org> Co-authored-by: luisherranz <luisherranz@git.wordpress.org> Co-authored-by: samueljseay <samueljseay@git.wordpress.org> Co-authored-by: DAreRodz <darerodz@git.wordpress.org> Co-authored-by: ellatrix <ellatrix@git.wordpress.org> Co-authored-by: t-hamano <wildworks@git.wordpress.org>

t-hamano · 2025-11-24T15:35:25Z

This PR was manually backported into the wp/6.9 branch by #73512.

westonruter and others added 16 commits October 17, 2025 09:40

Reuse wp_script_attributes filter for adding data-wp-router-options a…

04f073d

…ttribute to script module

Use wp_json_encode()

d14f94b

Make gutenberg_script_module_add_router_options_attributes() more con…

ac4e28e

…cise

Improve phpdoc return tags

67db04c

Remove compat/wordpress-6.9/script-modules.php

ffc4cc4

Update backport changelog

4d07b05

Merge branch 'trunk' of https://github.com/WordPress/gutenberg into u…

5e78cd1

…pdate/script-module-router-options-attributes

Merge branch 'trunk' of https://github.com/WordPress/gutenberg into u…

e519c02

…pdate/script-module-router-options-attributes

(WIP) Use render_block_data to filter all blocks

1b164c3

co-authored: @samueljseay

Adjust manual registration of blocks in e2e tests

2300793

We should not need any manual registration now.

5d5f35c

Update changelog to match new wordpress-develop PR.

43fe04f

Merge remote-tracking branch 'origin/trunk' into update/script-module…

8cb5456

…-router-options-attributes

Fix merge conflict mistake

4b03144

Remove redundant white space change

b7c8664

Fix merge conflict mistake

dcb4834

samueljseay changed the title ~~[WIP] Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module~~ Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module Oct 21, 2025

samueljseay marked this pull request as ready for review October 21, 2025 09:28

samueljseay requested review from ajitbohra, nerrad, ntwb and spacedmonkey as code owners October 21, 2025 09:28

luisherranz assigned samueljseay Oct 21, 2025

samueljseay mentioned this pull request Oct 21, 2025

Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #72449

Closed

luisherranz requested changes Oct 21, 2025

View reviewed changes

Move conditional code to compat, check for existence of new method wh…

a46140a

…en re-registering existing core blocks

Simplify the compatibility check.

00ae9f6

luisherranz enabled auto-merge (squash) October 22, 2025 05:40

luisherranz merged commit 8fd4c71 into WordPress:trunk Oct 22, 2025
45 of 47 checks passed

github-actions bot mentioned this pull request Oct 22, 2025

PHP backports for WP 6.9 #72379

Open

github-actions bot added this to the Gutenberg 22.0 milestone Oct 22, 2025

luisherranz mentioned this pull request Oct 22, 2025

iAPI Router: Selectively preload interactivity script modules #72340

Merged

priethor modified the milestones: Gutenberg 22.0, Gutenberg 21.9 Oct 22, 2025

priethor removed the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Oct 22, 2025

luisherranz mentioned this pull request Oct 22, 2025

Build: Auto-register script modules #72541

Merged

ellatrix added the Backport to WP 6.9 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta label Nov 24, 2025

t-hamano added Backport to WP 6.9 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta and removed Backport to WP 6.9 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta labels Nov 24, 2025

t-hamano mentioned this pull request Nov 24, 2025

Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #73512

Merged

t-hamano added Backported to WP Core Pull request that has been successfully merged into WP Core and removed Backport to WP 6.9 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta labels Nov 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #72489

Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #72489

Uh oh!

samueljseay commented Oct 20, 2025 •

edited

Loading

Uh oh!

luisherranz left a comment

Uh oh!

luisherranz Oct 21, 2025

Uh oh!

samueljseay Oct 21, 2025

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

Uh oh!

priethor commented Oct 22, 2025

Uh oh!

ellatrix commented Nov 24, 2025

Uh oh!

t-hamano commented Nov 24, 2025

Uh oh!

t-hamano commented Nov 24, 2025

Uh oh!

t-hamano commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #72489

Reuse wp_script_attributes filter for adding data-wp-router-options attribute to script module #72489

Uh oh!

Conversation

samueljseay commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Testing Instructions

Uh oh!

luisherranz left a comment

Choose a reason for hiding this comment

Uh oh!

luisherranz Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

samueljseay Oct 21, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

Uh oh!

priethor commented Oct 22, 2025

Uh oh!

ellatrix commented Nov 24, 2025

Uh oh!

t-hamano commented Nov 24, 2025

Uh oh!

t-hamano commented Nov 24, 2025

Uh oh!

t-hamano commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

samueljseay commented Oct 20, 2025 •

edited

Loading