Changeset 53874 for trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php

Timestamp:

08/11/2022 12:37:05 PM (2 years ago)

Author:

swissspidy

Message:

I18N: Introduce WP_Textdomain_Registry to store text domains and their language directory paths.

Previously, when using switch_to_locale() all current loaded text domains were unloaded and added to the $l10n_unloaded global. This prevented the just-in-time loading for text domains after a switch. The just-in-time loading was also only possible if the translations were stored in WP_LANG_DIR. Both issues have been fixed.

• Adds WP_Textdomain_Registry to keep track of the language directory paths for all plugins and themes.
• Updates all load_*_textdomain() functions to store the path in WP_Textdomain_Registry.
• Adds $locale parameter to load_textdomain() to specify the locale the translation file is for.
• Adds $reloadable parameter to unload_textdomain() to define whether a text domain can be loaded just-in-time again. This is used by WP_Locale_Switcher::load_translations().
• Extends _load_textdomain_just_in_time() to also support text domains of plugins and themes with custom language directories.
• Fixes the incorrect test_plugin_translation_after_switching_locale_twice() test which should have caught this issue earlier.
• Adds a new test plugin and theme to test the loading of translations with a custom language directory.
• Deprecates the now unused and private _get_path_to_translation() and _get_path_to_translation_from_lang_dir() functions.

Previously added in [49236] and reverted in [49236] to investigate concerns which are now addressed here.

Props yoavf, swissspidy, dd32, ocean90.
See #26511.
Fixes #39210.

File:

• trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php (modified) (2 diffs)

trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php

@@ -23 +23 @@
         $this->previous_locale = '';
 
-        unset( $GLOBALS['l10n'] );
-        unset( $GLOBALS['l10n_unloaded'] );
-        _get_path_to_translation( null, true );
+        unset( $GLOBALS['l10n'], $GLOBALS['l10n_unloaded'] );
+
+        /** @var WP_Textdomain_Registry $wp_textdomain_registry */
+        global $wp_textdomain_registry;
+
+        $wp_textdomain_registry->reset();
     }
 
     public function tear_down() {
-        unset( $GLOBALS['l10n'] );
-        unset( $GLOBALS['l10n_unloaded'] );
-        _get_path_to_translation( null, true );
+        unset( $GLOBALS['l10n'], $GLOBALS['l10n_unloaded'] );
+
+        /** @var WP_Textdomain_Registry $wp_textdomain_registry */
+        global $wp_textdomain_registry;
+
+        $wp_textdomain_registry->reset();
 
         parent::tear_down();
@@ -459 +465 @@
     }
 
+    /**
+     * @ticket 39210
+     */
+    public function test_switch_reloads_plugin_translations_outside_wp_lang_dir() {
+        /** @var WP_Textdomain_Registry $wp_textdomain_registry */
+        global $wp_locale_switcher, $wp_textdomain_registry;
+
+        $locale_switcher = clone $wp_locale_switcher;
+
+        $wp_locale_switcher = new WP_Locale_Switcher();
+        $wp_locale_switcher->init();
+
+        require_once DIR_TESTDATA . '/plugins/custom-internationalized-plugin/custom-internationalized-plugin.php';
+
+        $registry_value = $wp_textdomain_registry->get( 'custom-internationalized-plugin', determine_locale() );
+
+        $actual = custom_i18n_plugin_test();
+
+        switch_to_locale( 'es_ES' );
+        switch_to_locale( 'de_DE' );
+
+        $actual_de_de = custom_i18n_plugin_test();
+
+        restore_previous_locale();
+
+        $actual_es_es = custom_i18n_plugin_test();
+
+        restore_current_locale();
+
+        $wp_locale_switcher = $locale_switcher;
+
+        $this->assertSame( 'This is a dummy plugin', $actual );
+        $this->assertSame( WP_PLUGIN_DIR . '/custom-internationalized-plugin/languages/', $registry_value );
+        $this->assertSame( 'Das ist ein Dummy Plugin', $actual_de_de );
+        $this->assertSame( 'Este es un plugin dummy', $actual_es_es );
+    }
+
+    /**
+     * @ticket 39210
+     */
+    public function test_switch_reloads_theme_translations_outside_wp_lang_dir() {
+        /** @var WP_Textdomain_Registry $wp_textdomain_registry */
+        global $wp_locale_switcher, $wp_textdomain_registry;
+
+        $locale_switcher = clone $wp_locale_switcher;
+
+        $wp_locale_switcher = new WP_Locale_Switcher();
+        $wp_locale_switcher->init();
+
+        switch_theme( 'custom-internationalized-theme' );
+
+        require_once get_stylesheet_directory() . '/functions.php';
+
+        $registry_value = $wp_textdomain_registry->get( 'custom-internationalized-theme', determine_locale() );
+
+        $actual = custom_i18n_theme_test();
+
+        switch_to_locale( 'es_ES' );
+        switch_to_locale( 'de_DE' );
+
+        $actual_de_de = custom_i18n_theme_test();
+
+        restore_previous_locale();
+
+        $actual_es_es = custom_i18n_theme_test();
+
+        restore_current_locale();
+
+        $wp_locale_switcher = $locale_switcher;
+
+        $this->assertSame( get_template_directory() . '/languages/', $registry_value );
+        $this->assertSame( 'This is a dummy theme', $actual );
+        $this->assertSame( 'Das ist ein Dummy Theme', $actual_de_de );
+        $this->assertSame( 'Este es un tema dummy', $actual_es_es );
+    }
+
     public function filter_locale() {
         return 'es_ES';