<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[57840] trunk: Script Loader: Add new `script_module_loader_src` filter for the script module `src`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/57840">57840</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/57840","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-03-15 11:27:12 +0000 (Fri, 15 Mar 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Script Loader: Add new `script_module_loader_src` filter for the script module `src`.
Ensures parity with the `script_loader_src` filter for regular scripts, allowing the URL to be filtered, for example to load them from a CDN or alter query parameters.
Props dd32, peterwilsoncc, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/60742">#60742</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpscriptmodulesphp">trunk/src/wp-includes/class-wp-script-modules.php</a></li>
<li><a href="#trunktestsphpunittestsscriptmoduleswpScriptModulesphp">trunk/tests/phpunit/tests/script-modules/wpScriptModules.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpscriptmodulesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-script-modules.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-script-modules.php 2024-03-15 11:23:18 UTC (rev 57839)
+++ trunk/src/wp-includes/class-wp-script-modules.php 2024-03-15 11:27:12 UTC (rev 57840)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,7 +191,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_print_script_tag(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'module',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'src' => $this->get_versioned_src( $script_module ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'src' => $this->get_src( $id ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'id' => $id . '-js-module',
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,7 +212,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true !== $script_module['enqueue'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> '<link rel="modulepreload" href="%s" id="%s">',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- esc_url( $this->get_versioned_src( $script_module ) ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ esc_url( $this->get_src( $id ) ),
</ins><span class="cx" style="display: block; padding: 0 10px"> esc_attr( $id . '-js-modulepreload' )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -264,7 +264,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private function get_import_map(): array {
</span><span class="cx" style="display: block; padding: 0 10px"> $imports = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ) ) as $id => $script_module ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $imports[ $id ] = $this->get_versioned_src( $script_module );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $imports[ $id ] = $this->get_src( $id );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return array( 'imports' => $imports );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -331,19 +331,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $script_module The script module.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $id The script module identifier.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The script module src with a version if relevant.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- private function get_versioned_src( array $script_module ): string {
- $args = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function get_src( string $id ): string {
+ if ( ! isset( $this->registered[ $id ] ) ) {
+ return '';
+ }
+
+ $script_module = $this->registered[ $id ];
+ $src = $script_module['src'];
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false === $script_module['version'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args['ver'] = get_bloginfo( 'version' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src = add_query_arg( 'ver', get_bloginfo( 'version' ), $src );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( null !== $script_module['version'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args['ver'] = $script_module['version'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $src = add_query_arg( 'ver', $script_module['version'], $src );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $args ) {
- return add_query_arg( $args, $script_module['src'] );
- }
- return $script_module['src'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Filters the script module source.
+ *
+ * @since 6.5.0
+ *
+ * @param string $src Module source url.
+ * @param string $id Module identifier.
+ */
+ $src = apply_filters( 'script_module_loader_src', $src, $id );
+
+ return $src;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsscriptmoduleswpScriptModulesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/script-modules/wpScriptModules.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/script-modules/wpScriptModules.php 2024-03-15 11:23:18 UTC (rev 57839)
+++ trunk/tests/phpunit/tests/script-modules/wpScriptModules.php 2024-03-15 11:27:12 UTC (rev 57840)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -512,48 +512,72 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Tests the functionality of the `get_versioned_src` method to ensure
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tests the functionality of the `get_src` method to ensure
</ins><span class="cx" style="display: block; padding: 0 10px"> * proper URLs with version strings are returned.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 56313
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::get_versioned_src()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::get_src()
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_get_versioned_src() {
- $get_versioned_src = new ReflectionMethod( $this->script_modules, 'get_versioned_src' );
- $get_versioned_src->setAccessible( true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_src() {
+ $get_src = new ReflectionMethod( $this->script_modules, 'get_src' );
+ $get_src->setAccessible( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $module_with_version = array(
- 'src' => 'http://example.com/module.js',
- 'version' => '1.0',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->script_modules->register(
+ 'module_with_version',
+ 'http://example.com/module.js',
+ array(),
+ '1.0'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $get_versioned_src->invoke( $this->script_modules, $module_with_version );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = $get_src->invoke( $this->script_modules, 'module_with_version' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'http://example.com/module.js?ver=1.0', $result );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $module_without_version = array(
- 'src' => 'http://example.com/module.js',
- 'version' => null,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->script_modules->register(
+ 'module_without_version',
+ 'http://example.com/module.js',
+ array(),
+ null
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $get_versioned_src->invoke( $this->script_modules, $module_without_version );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = $get_src->invoke( $this->script_modules, 'module_without_version' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'http://example.com/module.js', $result );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $module_with_wp_version = array(
- 'src' => 'http://example.com/module.js',
- 'version' => false,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->script_modules->register(
+ 'module_with_wp_version',
+ 'http://example.com/module.js',
+ array(),
+ false
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $get_versioned_src->invoke( $this->script_modules, $module_with_wp_version );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = $get_src->invoke( $this->script_modules, 'module_with_wp_version' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'http://example.com/module.js?ver=' . get_bloginfo( 'version' ), $result );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $module_with_existing_query_string = array(
- 'src' => 'http://example.com/module.js?foo=bar',
- 'version' => '1.0',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->script_modules->register(
+ 'module_with_existing_query_string',
+ 'http://example.com/module.js?foo=bar',
+ array(),
+ '1.0'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = $get_versioned_src->invoke( $this->script_modules, $module_with_existing_query_string );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $result = $get_src->invoke( $this->script_modules, 'module_with_existing_query_string' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'http://example.com/module.js?foo=bar&ver=1.0', $result );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Filter the version to include the ID in the final URL, to test the filter, this should affect the tests below.
+ add_filter(
+ 'script_module_loader_src',
+ function ( $src, $id ) {
+ return add_query_arg( 'script_module_id', urlencode( $id ), $src );
+ },
+ 10,
+ 2
+ );
+
+ $result = $get_src->invoke( $this->script_modules, 'module_without_version' );
+ $this->assertEquals( 'http://example.com/module.js?script_module_id=module_without_version', $result );
+
+ $result = $get_src->invoke( $this->script_modules, 'module_with_existing_query_string' );
+ $this->assertEquals( 'http://example.com/module.js?foo=bar&ver=1.0&script_module_id=module_with_existing_query_string', $result );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>