Changeset 50408 for trunk/src/wp-includes/class.wp-scripts.php

Timestamp:

02/22/2021 11:21:56 PM (6 years ago)

Author:

peterwilsoncc

Message:

Script Loader: Prevent wp_localize_script() warnings.

Prevent wp_localize_script() (via WP_Scripts::localize()) throwing warnings in PHP 8 when the translation data is passed as a string. This maintains backward compatibility with earlier versions of PHP.

Introduce a _doing_it_wrong() notice to WP_Scripts::localize() if the translation data is not passed as an array.

Props jrf, peterwilsoncc, SergeyBiryukov.
Fixes #52534.

File:

• trunk/src/wp-includes/class.wp-scripts.php (modified) (1 diff)

trunk/src/wp-includes/class.wp-scripts.php

@@ -485 +485 @@
                 }
 
-                foreach ( (array) $l10n as $key => $value ) {
-                        if ( ! is_scalar( $value ) ) {
-                                continue;
+                if ( ! is_array( $l10n ) ) {
+                        _doing_it_wrong(
+                                __METHOD__,
+                                sprintf(
+                                        /* translators: 1: $l10n, 2: wp_add_inline_script() */
+                                        __( 'The %1$s parameter must be an array. To pass arbitrary data to scripts, use the %2$s function instead.' ),
+                                        '<code>$l10n</code>',
+                                        '<code>wp_add_inline_script()</code>'
+                                ),
+                                '5.7.0'
+                        );
+                }
+
+                if ( is_string( $l10n ) ) {
+                        $l10n = html_entity_decode( $l10n, ENT_QUOTES, 'UTF-8' );
+                } else {
+                        foreach ( (array) $l10n as $key => $value ) {
+                                if ( ! is_scalar( $value ) ) {
+                                        continue;
+                                }
+
+                                $l10n[ $key ] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8' );
                         }
-
-                        $l10n[ $key ] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8' );
                 }