Add fetchpriority=low support to script modules #70173
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -653,8 +653,23 @@ function gutenberg_default_script_modules() { | |
| break; | ||
| } | ||
|
|
||
| /* | ||
| * All script modules in Gutenberg are (currently) related to the Interactivity API which prioritizes server-side rendering. | ||
| * Therefore, the modules should be fetched with a low priority to avoid network contention with any LCP element resource. | ||
| * For allowing a block to opt-in to another fetchpriority, see <https://github.com/WordPress/gutenberg/issues/71366>. | ||
| * | ||
| * Also, the @wordpress/a11y script module is intended to be used as a dynamic import dependency, in which case | ||
| * the fetchpriority is irrelevant. See <https://make.wordpress.org/core/2024/10/14/updates-to-script-modules-in-6-7/>. | ||
| * However, in case it is added as a static import dependency, the fetchpriority is explicitly set to be 'low' | ||
| * since the module should not be involved in the critical rendering path, and if it is, its fetchpriority will | ||
| * be bumped to match the fetchpriority of the dependent script. | ||
| */ | ||
| $args = array( | ||
| 'fetchpriority' => 'low', | ||
| ); | ||
|
|
||
| $path = gutenberg_url( "build-module/{$file_name}" ); | ||
| wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'], $args ); // The $args parameter is new as of WP 6.9 per <https://core.trac.wordpress.org/ticket/61734>. | ||
|
Member
There was a problem hiding this comment. I checked to make sure extra arguments to functions don't cause errors/warnings/notices and that does seem to be the case 👍
Member
Author
There was a problem hiding this comment. Yeah, adding extra arguments is fine. No complaints going back even to PHP 4.3: https://3v4l.org/doYun Any additional unnamed params could be obtained by the function via |
||
| } | ||
| } | ||
| remove_action( 'wp_default_scripts', 'wp_default_script_modules' ); | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's
@wordpress/a11ymodule that's not strictly an iAPI concept.https://make.wordpress.org/core/2024/10/14/updates-to-script-modules-in-6-7/
I don't think other modules have been introduced, but I could have missed something. Should
a11ybelowas well?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strictly, but it is only used by the
interactivity-router, right? And it is used as a dynamic import, so it exists exclusively in theimportmapand so there is nofetchpriorityto print.Granted, it could end up getting added as a static dependency. If I try doing that, I see that with this Gutenberg PR it is printed with
fetchpriority=low, but if I try WP Coretrunkthen it omitsfetchpriority(so it isauto).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've addressed this in 1ab3c34.
And in core, I've addressed in WordPress/wordpress-develop#9770 via WordPress/wordpress-develop@e2d4676