Changeset 59433

Timestamp:

11/20/2024 01:32:57 PM (11 days ago)

Author:

desrosj

Message:

i18n: Account for load_*_textdomain() after JIT loading.

When load_*_textdomain() functions are called after WordPress has already attempted just-in-time loading of translations, nothing happens.

This updates the related logic to retry translation loading when a custom path is set to ensure all translations are available.

Additionally, this also fixes cases where an en_US.mo file is provided with non-English strings to override the default language.

Follow up to [59157].

Reviewed by SergeyBiryukov.
Merges [59430] to the 6.7 branch.

Props swissspidy, peterwilsoncc, desrosj, apermo, sergeybiryukov, wildworks, tigriweb, twvania, looswebstudio, stimul, audrasjb, finntown, bluantinoo, timwhitlock, albigdd.
See #62337.

Location:

branches/6.7

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-textdomain-registry.php (modified) (2 diffs)
• src/wp-includes/l10n.php (modified) (9 diffs)
• tests/phpunit/data/plugins/custom-internationalized-plugin/custom-internationalized-plugin.php (modified) (1 diff)
• tests/phpunit/tests/l10n/loadTextdomainJustInTime.php (modified) (1 diff)
• tests/phpunit/tests/l10n/wpLocaleSwitcher.php (modified) (1 diff)
• tests/phpunit/tests/l10n/wpTextdomainRegistry.php (modified) (1 diff)

branches/6.7/src/wp-includes/class-wp-textdomain-registry.php

@@ -154 +154 @@
      */
     public function set_custom_path( $domain, $path ) {
+        // If just-in-time loading was triggered before, reset the entry so it can be tried again.
+
+        if ( isset( $this->all[ $domain ] ) ) {
+            $this->all[ $domain ] = array_filter( $this->all[ $domain ] );
+        }
+
+        if ( empty( $this->current[ $domain ] ) ) {
+            unset( $this->current[ $domain ] );
+        }
+
         $this->custom_paths[ $domain ] = rtrim( $path, '/' );
     }
@@ -337 +347 @@
          * using load_plugin_textdomain/load_theme_textdomain, use that one.
          */
-        if ( 'en_US' !== $locale && isset( $this->custom_paths[ $domain ] ) ) {
+        if ( isset( $this->custom_paths[ $domain ] ) ) {
             $fallback_location = rtrim( $this->custom_paths[ $domain ], '/' ) . '/';
             $this->set( $domain, $locale, $fallback_location );

branches/6.7/src/wp-includes/l10n.php

@@ -986 +986 @@
  * @since 6.7.0 Translations are no longer immediately loaded, but handed off to the just-in-time loading mechanism.
  *
+ * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
+ * @global array<string, WP_Translations|NOOP_Translations> $l10n An array of all currently loaded text domains.
+ *
  * @param string       $domain          Unique identifier for retrieving translated strings
  * @param string|false $deprecated      Optional. Deprecated. Use the $plugin_rel_path parameter instead.
@@ -995 +998 @@
 function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
     /** @var WP_Textdomain_Registry $wp_textdomain_registry */
-    global $wp_textdomain_registry;
+    /** @var array<string, WP_Translations|NOOP_Translations> $l10n */
+    global $wp_textdomain_registry, $l10n;
 
     if ( ! is_string( $domain ) ) {
@@ -1012 +1016 @@
     $wp_textdomain_registry->set_custom_path( $domain, $path );
 
+    // If just-in-time loading was triggered before, reset the entry so it can be tried again.
+    if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof NOOP_Translations ) {
+        unset( $l10n[ $domain ] );
+    }
+
     return true;
 }
@@ -1023 +1032 @@
  *
  * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
+ * @global array<string, WP_Translations|NOOP_Translations> $l10n An array of all currently loaded text domains.
  *
  * @param string $domain             Text domain. Unique identifier for retrieving translated strings.
@@ -1031 +1041 @@
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
     /** @var WP_Textdomain_Registry $wp_textdomain_registry */
-    global $wp_textdomain_registry;
+    /** @var array<string, WP_Translations|NOOP_Translations> $l10n */
+    global $wp_textdomain_registry, $l10n;
 
     if ( ! is_string( $domain ) ) {
@@ -1040 +1051 @@
 
     $wp_textdomain_registry->set_custom_path( $domain, $path );
+
+    // If just-in-time loading was triggered before, reset the entry so it can be tried again.
+    if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof NOOP_Translations ) {
+        unset( $l10n[ $domain ] );
+    }
 
     return true;
@@ -1057 +1073 @@
  *
  * @global WP_Textdomain_Registry $wp_textdomain_registry WordPress Textdomain Registry.
+ * @global array<string, WP_Translations|NOOP_Translations> $l10n An array of all currently loaded text domains.
  *
  * @param string       $domain Text domain. Unique identifier for retrieving translated strings.
@@ -1065 +1082 @@
 function load_theme_textdomain( $domain, $path = false ) {
     /** @var WP_Textdomain_Registry $wp_textdomain_registry */
-    global $wp_textdomain_registry;
+    /** @var array<string, WP_Translations|NOOP_Translations> $l10n */
+    global $wp_textdomain_registry, $l10n;
 
     if ( ! is_string( $domain ) ) {
@@ -1076 +1094 @@
 
     $wp_textdomain_registry->set_custom_path( $domain, $path );
+
+    // If just-in-time loading was triggered before, reset the entry so it can be tried again.
+    if ( isset( $l10n[ $domain ] ) && $l10n[ $domain ] instanceof NOOP_Translations ) {
+        unset( $l10n[ $domain ] );
+    }
 
     return true;

branches/6.7/tests/phpunit/data/plugins/custom-internationalized-plugin/custom-internationalized-plugin.php

@@ -8 +8 @@
 */
 
-load_plugin_textdomain( 'custom-internationalized-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
+function custom_i18n_load_textdomain() {
+    load_plugin_textdomain( 'custom-internationalized-plugin', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' );
+}
+
+add_action( 'init', 'custom_i18n_load_textdomain' );
 
 function custom_i18n_plugin_test() {

branches/6.7/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

@@ -343 +343 @@
         $this->assertSame( 1, $filter->get_call_count() );
     }
+
+    /**
+     * @ticket 44937
+     * @ticket 62337
+     *
+     * @covers ::load_plugin_textdomain
+     * @covers ::is_textdomain_loaded
+     * @covers WP_Textdomain_Registry::set_custom_path
+     */
+    public function test_plugin_translation_should_be_translated_when_calling_load_plugin_textdomain_too_late() {
+        require_once DIR_TESTDATA . '/plugins/custom-internationalized-plugin/custom-internationalized-plugin.php';
+
+        add_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
+
+        $is_textdomain_loaded_before = is_textdomain_loaded( 'custom-internationalized-plugin' );
+        $output_before               = custom_i18n_plugin_test();
+
+        $is_textdomain_loaded_middle = is_textdomain_loaded( 'custom-internationalized-plugin' );
+
+        custom_i18n_load_textdomain();
+
+        $output_after               = custom_i18n_plugin_test();
+        $is_textdomain_loaded_after = is_textdomain_loaded( 'custom-internationalized-plugin' );
+
+        $this->assertFalse( $is_textdomain_loaded_before );
+        $this->assertFalse( $is_textdomain_loaded_middle );
+        $this->assertSame( 'This is a dummy plugin', $output_before );
+        $this->assertSame( 'Das ist ein Dummy Plugin', $output_after );
+        $this->assertTrue( $is_textdomain_loaded_after );
+    }
 }

branches/6.7/tests/phpunit/tests/l10n/wpLocaleSwitcher.php

@@ -494 +494 @@
         require_once DIR_TESTDATA . '/plugins/custom-internationalized-plugin/custom-internationalized-plugin.php';
 
+        custom_i18n_load_textdomain();
+
         $actual = custom_i18n_plugin_test();
 

branches/6.7/tests/phpunit/tests/l10n/wpTextdomainRegistry.php

@@ -40 +40 @@
             'Incorrect availability status for textdomain with custom path'
         );
-        $this->assertFalse(
+        $this->assertSame(
+            WP_LANG_DIR . '/bar/',
             $this->instance->get( 'foo', 'en_US' ),
-            'Should not return custom path for textdomain and en_US locale'
+            'Should return custom path for textdomain and en_US locale'
         );
         $this->assertSame(