Changeset 58078

Timestamp:

05/02/2024 03:04:04 PM (18 months ago)

Author:

jorbin

Message:

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 [58068] to the 6.5 branch.

Props salcode, aslamdoctor, jorbin, swissspidy.
Fixes #60862.

Location:

branches/6.5

Files:

• . (modified) (1 prop)
• src/wp-includes/functions.wp-scripts.php (modified) (2 diffs)
• tests/e2e/specs/login-localize-script.test.js (copied) (copied from trunk/tests/e2e/specs/login-localize-script.test.js)
• tests/phpunit/tests/dependencies/wpLocalizeScript.php (copied) (copied from trunk/tests/phpunit/tests/dependencies/wpLocalizeScript.php)

branches/6.5/src/wp-includes/functions.wp-scripts.php

@@ -212 +212 @@
  * @see WP_Scripts::localize()
  * @link https://core.trac.wordpress.org/ticket/11520
- * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
  *
  * @since 2.2.0
@@ -225 +224 @@
  */
 function wp_localize_script( $handle, $object_name, $l10n ) {
-    global $wp_scripts;
-
-    if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
-        _wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
-        return false;
-    }
+    $wp_scripts = wp_scripts();
 
     return $wp_scripts->localize( $handle, $object_name, $l10n );