Ticket #29722: 29722.4.diff

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

@@ -204 +204 @@
         }
 
         /**
-         * Localizes a script, only if the script has already been added
+         * Localizes a script, but only if the script has already been added.
          *
-         * @param string $handle
-         * @param string $object_name
-         * @param array $l10n
-         * @return bool
+         * This serves as a method to pass data from the PHP environment to the
+         * front-end to be accessible from javascript scripts.
+         *
+         * @param  string       $handle      Unique script handle.
+         *                                   The localized variables will be loaded
+         *                                   before this script (as long as the
+         *                                   script has beeen enqueued/registered).
+         *
+         * @param  string       $object_name The javascript varibale name.
+         *
+         * @param  array|scalar $l10n        An array or scalar value which should
+         *                                   be encoded as the value to the
+         *                                   variable name.
+         *
+         * @return bool True on success, false on failure.
          */
         public function localize( $handle, $object_name, $l10n ) {
-                if ( $handle === 'jquery' )
+                if ( 'jquery' === $handle ) {
                         $handle = 'jquery-core';
+                }
 
                 if ( is_array($l10n) && isset($l10n['l10n_print_after']) ) { // back compat, preserve the code in 'l10n_print_after' if present
                         $after = $l10n['l10n_print_after'];
@@ -220 +232 @@
                         unset($l10n['l10n_print_after']);
                 }
 
-                foreach ( (array) $l10n as $key => $value ) {
-                        if ( !is_scalar($value) )
-                                continue;
-
-                        $l10n[$key] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8');
+                if ( is_scalar( $l10n ) ) {
+                        // If the value is scalar, simply decode it
+                        $l10n = html_entity_decode( (string) $l10n, ENT_QUOTES, 'UTF-8' );
+                } else {
+                        $l10n = $this->entity_decode_array_values( $l10n );
                 }
 
                 $script = "var $object_name = " . wp_json_encode( $l10n ) . ';';
@@ -241 +253 @@
         }
 
         /**
+         * Handles recursively html entity decodeing multi-dimensional array values.
+         *
+         * @param  array $l10n_array Array of localizable data which should be decoded.
+         *
+         * @return array Array with decoded values.
+         */
+        public function entity_decode_array_values( $l10n_array ) {
+                // begin a new array so that non-decoded values do not get added.
+                $l10n = array();
+
+                foreach ( (array) $l10n_array as $key => $value ) {
+                        if ( is_array( $value ) ) {
+                                $l10n[ $key ] = $this->entity_decode_array_values( $value );
+                        }
+
+                        // non-array, non-scalar values should not be added
+                        if ( ! is_scalar( $value ) ) {
+                                continue;
+                        }
+
+                        $l10n[ $key ] = html_entity_decode( (string) $value, ENT_QUOTES, 'UTF-8' );
+                }
+
+                return $l10n;
+        }
+
+        /**
          * @param string $handle    Name of the item. Should be unique.
          * @param bool   $recursion Internal flag that calling function was called recursively.
          * @param mixed  $group     Group level.

tests/phpunit/tests/dependencies/scripts.php

@@ -156 +156 @@
                 $this->assertEquals( '', get_echo( 'wp_print_scripts' ) );
         }
 
+        /**
+         * Testing `wp_localize_script` with scalar and array values.
+         * @ticket 29722
+         */
+        function test_wp_localize_script_with_non_array() {
+                // Enqueue & localize variables
+                wp_enqueue_script( 'test-l10n-data', 'example.com', array(), null );
+                wp_localize_script( 'test-l10n-data', 'data', true );
+
+                $test_array = array( 'var' => 'string' );
+                wp_localize_script( 'test-l10n-data', 'dataArray', $test_array );
+
+                $test_multidimensional = array(
+                        'first-level' => array(
+                                'second-level' => array(
+                                        'index' => "I'll \"walk\" the <b>dog</b> now",
+                                ),
+                        ),
+                );
+                wp_localize_script( 'test-l10n-data', 'dataMultiDimensionalArray', $test_multidimensional );
+
+                // Boolean output.
+                $expected = "var data = \"1\";\n";
+
+                // One-dimensional array output.
+                $expected .= "var dataArray = {\"var\":\"string\"};\n";
+
+                // Multi-dimensional array output with odd characters.
+                $string = '\"walk\"';
+                $expected .= "var dataMultiDimensionalArray = {\"first-level\":{\"second-level\":{\"index\":\"I'll " . $string . " the <b>dog<\/b> now\"}}};\n";
+
+                // var script wrapper output
+                $expected = "<script type='text/javascript'>\n/* <![CDATA[ */\n$expected/* ]]> */\n</script>\n";
+                // script link output
+                $expected .= "<script type='text/javascript' src='http://example.com'></script>\n";
+
+                $this->assertEquals( $expected, get_echo( 'wp_print_scripts' ) );
+
+                // No scripts left to print
+                $this->assertEquals( '', get_echo( 'wp_print_scripts' ) );
+        }
+
     /**
      * Testing 'wp_register_script' return boolean success/failure value.
      *