Changeset 50259

Timestamp:

02/08/2021 11:49:33 PM (4 years ago)

Author:

noisysocks

Message:

Fix wp.i18n.isRTL()

Fixes a bug causing wp.i18n.isRTL() to return false in RTL langauges by manually
loading the translated 'ltr' string for the i18n dependency. This ports over an
identical fix that was made in Gutenberg.

Fixes #52441.
Props @jonsurrell @youknowriad.

Location:

trunk

Files:

• package-lock.json (modified) (2 diffs)
• src/wp-includes/script-loader.php (modified) (1 diff)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)

trunk/package-lock.json

@@ -3932 +3932 @@
                         "unbzip2-stream": "^1.3.3",
                         "ws": "^7.2.3"
+                    },
+                    "dependencies": {
+                        "devtools-protocol": {
+                            "version": "0.0.818844",
+                            "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.818844.tgz",
+                            "integrity": "sha512-AD1hi7iVJ8OD0aMLQU5VK0XH9LDlA1+BcPIgrAxPfaibx2DbWucuyOhc4oyQCbnvDDO68nN6/LcKfqTP343Jjg==",
+                            "dev": true
+                        }
                     }
                 },
@@ -8057 +8065 @@
             "resolved": "https://registry.npmjs.org/detect-node/-/detect-node-2.0.4.tgz",
             "integrity": "sha512-ZIzRpLJrOj7jjP2miAtgqIfmzbxa4ZOr5jJc601zklsfEx9oTzmmj2nVpIPRpNlRTIh8lc1kyViIY7BWSGNmKw==",
-            "dev": true
-        },
-        "devtools-protocol": {
-            "version": "0.0.818844",
-            "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.818844.tgz",
-            "integrity": "sha512-AD1hi7iVJ8OD0aMLQU5VK0XH9LDlA1+BcPIgrAxPfaibx2DbWucuyOhc4oyQCbnvDDO68nN6/LcKfqTP343Jjg==",
             "dev": true
         },

trunk/src/wp-includes/script-loader.php

@@ -267 +267 @@
         if ( in_array( 'wp-i18n', $dependencies, true ) ) {
             $scripts->set_translations( $handle );
+        }
+
+        // Manually set the text direction localization after wp-i18n is
+        // printed. This ensures that wp.i18n.isRTL() returns true in RTL
+        // languages. We cannot use $scripts->set_translations( 'wp-i18n' ) to
+        // do this because WordPress prints a script's translations *before*
+        // printing the script, which means, in the case of wp-i18n, that
+        // wp.i18n.setLocaleData() is called before wp.i18n is defined.
+        if ( 'wp-i18n' === $handle ) {
+            $ltr    = _x( 'ltr', 'text direction', 'default' );
+            $script = sprintf( "wp.i18n.setLocaleData( { 'text direction\u0004ltr': [ '%s' ] } );", $ltr );
+            $scripts->add_inline_script( $handle, $script, 'after' );
         }
     }

trunk/tests/phpunit/tests/dependencies/scripts.php

@@ -724 +724 @@
         $expected .= "<script type='text/javascript' src='/wp-includes/js/dist/hooks{$suffix}.js' id='wp-hooks-js'></script>\n";
         $expected .= "<script type='text/javascript' src='/wp-includes/js/dist/i18n{$suffix}.js' id='wp-i18n-js'></script>\n";
+        $expected .= "<script type='text/javascript' id='wp-i18n-js-after'>\n";
+        $expected .= "wp.i18n.setLocaleData( { 'text direction\u0004ltr': [ 'ltr' ] } );\n";
+        $expected .= "</script>\n";
         $expected .= "<script type='text/javascript' id='wp-a11y-js-translations'>\n";
         $expected .= "( function( domain, translations ) {\n";