Changeset 60728

Timestamp:

09/11/2025 10:11:40 AM (4 weeks ago)

Author:

swissspidy

Message:

I18N: Use Domain Path for script translations if available.

This is a follow-up to [59461] from 6.8, which leveraged Domain Path for just-in-time loading of MO/PHP translation files.

Now, the same is done for script translations, which means plugins/themes shipping with their own translation no longer need to manually specify the translation path when calling wp_set_script_translations().

Props tusharbharti, swissspidy, shailu25, jsnajdr.
See #62244, #54797.
Fixes #63944.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (3 diffs)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)

trunk/src/wp-includes/l10n.php

@@ -1135 +1135 @@
  * @see WP_Scripts::set_translations()
  *
+ * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
+ *
  * @param string $handle Name of the script to register a translation domain to.
  * @param string $domain Optional. Text domain. Default 'default'.
@@ -1142 +1144 @@
  */
 function load_script_textdomain( $handle, $domain = 'default', $path = '' ) {
+    /** @var WP_Textdomain_Registry $wp_textdomain_registry */
+    global $wp_textdomain_registry;
+
     $wp_scripts = wp_scripts();
 
@@ -1148 +1153 @@
     }
 
-    $path   = untrailingslashit( $path );
     $locale = determine_locale();
+
+    if ( ! $path ) {
+        $path = $wp_textdomain_registry->get( $domain, $locale );
+    }
+
+    $path = untrailingslashit( $path );
 
     // If a path was given and the handle file exists simply return it.

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

@@ -2629 +2629 @@
         );
         $expected .= "<script type='text/javascript' src='/wp-includes/js/script.js' id='test-example-js'></script>\n";
+
+        $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 63944
+     */
+    public function test_wp_set_script_translations_uses_registered_domainpath_for_plugin() {
+        global $wp_textdomain_registry;
+
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'domain-path-plugin', '/wp-content/plugins/my-plugin/js/script.js', array(), null );
+
+        // Simulate a plugin declaring DomainPath: /languages by registering a custom path.
+        $wp_textdomain_registry->set_custom_path( 'internationalized-plugin', DIR_TESTDATA . '/languages/plugins' );
+        wp_set_script_translations( 'domain-path-plugin', 'internationalized-plugin' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js' id='wp-i18n-js'></script>\n";
+        $expected .= str_replace(
+            array(
+                '__DOMAIN__',
+                '__HANDLE__',
+                '__JSON_TRANSLATIONS__',
+            ),
+            array(
+                'internationalized-plugin',
+                'domain-path-plugin',
+                file_get_contents( DIR_TESTDATA . '/languages/plugins/internationalized-plugin-en_US-2f86cb96a0233e7cb3b6f03ad573be0b.json' ),
+            ),
+            $this->wp_scripts_print_translations_output
+        );
+        $expected .= "<script type='text/javascript' src='/wp-content/plugins/my-plugin/js/script.js' id='domain-path-plugin-js'></script>\n";
+
+        $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) );
+    }
+
+    /**
+     * @ticket 63944
+     *
+     * Ensure human-readable script translation filenames are found when a
+     * textdomain has a custom DomainPath registered and no explicit $path is passed.
+     */
+    public function test_wp_set_script_translations_prefers_human_readable_filename_in_registered_domainpath() {
+        global $wp_textdomain_registry;
+
+        wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+        wp_enqueue_script( 'script-handle', '/wp-admin/js/script.js', array(), null );
+
+        // Register the admin textdomain path and use the admin translations file for this script-handle test.
+        $wp_textdomain_registry->set_custom_path( 'admin', DIR_TESTDATA . '/languages' );
+        wp_set_script_translations( 'script-handle', 'admin' );
+
+        $expected  = "<script type='text/javascript' src='/wp-includes/js/dist/wp-i18n.js' id='wp-i18n-js'></script>\n";
+        $expected .= str_replace(
+            array(
+                '__DOMAIN__',
+                '__HANDLE__',
+                '__JSON_TRANSLATIONS__',
+            ),
+            array(
+                'admin',
+                'script-handle',
+                file_get_contents( DIR_TESTDATA . '/languages/admin-en_US-script-handle.json' ),
+            ),
+            $this->wp_scripts_print_translations_output
+        );
+        $expected .= "<script type='text/javascript' src='/wp-admin/js/script.js' id='script-handle-js'></script>\n";
 
         $this->assertEqualHTML( $expected, get_echo( 'wp_print_scripts' ) );