<!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>[58078] branches/6.5/tests: Script Loader: Ensure wp_localize_script() works when called early.</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/58078">58078</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/58078","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-05-02 15:04:04 +0000 (Thu, 02 May 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: Ensure wp_localize_script() works when called early.
Before, wp_localize_script() did not work when the $wp_scripts global was not already set (for example because of a script registration happening elsewhere) and even emitted a warning in that case. Due to side effects such as block registration early in the load process, this usually never happened. However, the absence of these side effects in 6.5 caused the wp_localize_script() to no longer work in places such as the login_enqueue_scripts.
By calling wp_scripts() in wp_localize_script(), the $wp_scripts global is automatically set if needed, restoring previous behavior. Adds both a PHP unit test and an e2e test to verify this use case. Hat tip: jorbin.
Thanks for the birthday wishes, Pascal!
Reviewed by Jorbin.
Merges <a href="https://core.trac.wordpress.org/changeset/58068">[58068]</a> to the 6.5 branch.
Props salcode, aslamdoctor, jorbin, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/60862">#60862</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches65srcwpincludesfunctionswpscriptsphp">branches/6.5/src/wp-includes/functions.wp-scripts.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#branches65testse2especsloginlocalizescripttestjs">branches/6.5/tests/e2e/specs/login-localize-script.test.js</a></li>
<li><a href="#branches65testsphpunittestsdependencieswpLocalizeScriptphp">branches/6.5/tests/phpunit/tests/dependencies/wpLocalizeScript.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches65">branches/6.5/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/6.5
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/6.5 2024-05-02 14:40:30 UTC (rev 58077)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/6.5 2024-05-02 15:04:04 UTC (rev 58078)
</ins><a id="branches65"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/6.5</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.5:49373-49379,49381
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.8:51889
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:57791-57792,57804-57806,57809,57814,57817,57824,57826-57827,57831-57832,57835,57840-57841,57845,57851,57864-57865,57868,57870-57871,57878,57881,57885-57888,57902-57905,57918,57925,57928,57931,57933,57948,58028,58030,58049
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:57791-57792,57804-57806,57809,57814,57817,57824,57826-57827,57831-57832,57835,57840-57841,57845,57851,57864-57865,57868,57870-57871,57878,57881,57885-57888,57902-57905,57918,57925,57928,57931,57933,57948,58028,58030,58049,58068
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches65srcwpincludesfunctionswpscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/6.5/src/wp-includes/functions.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.5/src/wp-includes/functions.wp-scripts.php 2024-05-02 14:40:30 UTC (rev 58077)
+++ branches/6.5/src/wp-includes/functions.wp-scripts.php 2024-05-02 15:04:04 UTC (rev 58078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -211,7 +211,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Scripts::localize()
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://core.trac.wordpress.org/ticket/11520
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,13 +223,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the script was successfully localized, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_localize_script( $handle, $object_name, $l10n ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $wp_scripts;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_scripts = wp_scripts();
</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 ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
- _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
- return false;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $wp_scripts->localize( $handle, $object_name, $l10n );
</span><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="branches65testse2especsloginlocalizescripttestjsfromrev58068trunktestse2especsloginlocalizescripttestjs"></a>
<div class="copfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: branches/6.5/tests/e2e/specs/login-localize-script.test.js (from rev 58068, trunk/tests/e2e/specs/login-localize-script.test.js)</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.5/tests/e2e/specs/login-localize-script.test.js (rev 0)
+++ branches/6.5/tests/e2e/specs/login-localize-script.test.js 2024-05-02 15:04:04 UTC (rev 58078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,53 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * External dependencies
+ */
+import { existsSync, mkdirSync, writeFileSync, unlinkSync } from 'node:fs';
+import { join } from 'node:path';
+
+/**
+ * WordPress dependencies
+ */
+import { test, expect } from '@wordpress/e2e-test-utils-playwright';
+
+test.describe( 'Localize Script on wp-login.php', () => {
+ const muPlugins = join(
+ process.cwd(),
+ process.env.LOCAL_DIR ?? 'src',
+ 'wp-content/mu-plugins'
+ );
+ const muPluginFile = join( muPlugins, 'login-test.php' );
+
+ test.beforeAll( async () => {
+ const muPluginCode = `<?php
+ add_action(
+ 'login_enqueue_scripts',
+ function() {
+ wp_localize_script(
+ 'wp-util',
+ 'testData',
+ [
+ 'answerToTheUltimateQuestionOfLifeTheUniverseAndEverything' => 42,
+ ]
+ );
+ }
+ );`;
+
+ if ( ! existsSync( muPlugins ) ) {
+ mkdirSync( muPlugins, { recursive: true } );
+ }
+ writeFileSync( muPluginFile, muPluginCode );
+ } );
+
+ test.afterAll( async () => {
+ unlinkSync( muPluginFile );
+ } );
+
+ test( 'should localize script', async ( { page } ) => {
+ await page.goto( '/wp-login.php' );
+ await page.waitForSelector( '#login' );
+ const testData = await page.evaluate( () => window.testData );
+ expect(
+ testData.answerToTheUltimateQuestionOfLifeTheUniverseAndEverything
+ ).toBe( '42' );
+ } );
+} );
</ins></span></pre></div>
<a id="branches65testsphpunittestsdependencieswpLocalizeScriptphpfromrev58068trunktestsphpunittestsdependencieswpLocalizeScriptphp"></a>
<div class="copfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: branches/6.5/tests/phpunit/tests/dependencies/wpLocalizeScript.php (from rev 58068, trunk/tests/phpunit/tests/dependencies/wpLocalizeScript.php)</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/6.5/tests/phpunit/tests/dependencies/wpLocalizeScript.php (rev 0)
+++ branches/6.5/tests/phpunit/tests/dependencies/wpLocalizeScript.php 2024-05-02 15:04:04 UTC (rev 58078)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,41 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group dependencies
+ * @group scripts
+ */
+class Tests_Dependencies_LocalizeScript extends WP_UnitTestCase {
+ /**
+ * @var WP_Scripts
+ */
+ protected $old_wp_scripts;
+
+ public function set_up() {
+ parent::set_up();
+
+ $this->old_wp_scripts = $GLOBALS['wp_scripts'] ?? null;
+ $GLOBALS['wp_scripts'] = null;
+ }
+
+ public function tear_down() {
+ $GLOBALS['wp_scripts'] = $this->old_wp_scripts;
+ parent::tear_down();
+ }
+
+ /**
+ * Verifies that wp_localize_script() works if global has not been initialized yet.
+ *
+ * @ticket 60862
+ * @covers ::wp_localize_script
+ */
+ public function test_wp_localize_script_works_before_enqueue_script() {
+ $this->assertTrue(
+ wp_localize_script(
+ 'wp-util',
+ 'salcodeExample',
+ array(
+ 'answerToTheUltimateQuestionOfLifeTheUniverseAndEverything' => 42,
+ )
+ )
+ );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>