Changeset 37855

Timestamp:

06/23/2016 02:47:44 PM (7 years ago)

Author:

swissspidy

Message:

I18N: Enable unloading of text domains that have been loaded just in time.

[37415] removed the requirement to call load_plugin_textdomain() / load_theme_textdomain(). This caused unload_textdomain() to not work properly anymore in these cases.

With this change, unloaded text domains need to be explicitly loaded manually if you want to use them again.

Props swissspidy, ocean90.
Fixes #37113. See #34114.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (10 diffs)
• tests/phpunit/tests/l10n/loadTextdomainJustInTime.php (modified) (3 diffs)

trunk/src/wp-includes/l10n.php

@@ -510 +510 @@
  * @since 1.5.0
  *
- * @global array $l10n
+ * @global array $l10n          An array of all currently loaded text domains.
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
  *
  * @param string $domain Text domain. Unique identifier for retrieving translated strings.
@@ -517 +518 @@
  */
 function load_textdomain( $domain, $mofile ) {
-    global $l10n;
+    global $l10n, $l10n_unloaded;
+
+    $l10n_unloaded = (array) $l10n_unloaded;
 
     /**
@@ -531 +534 @@
 
     if ( true == $plugin_override ) {
+        unset( $l10n_unloaded[ $domain ] );
+
         return true;
     }
@@ -562 +567 @@
         $mo->merge_with( $l10n[$domain] );
 
+    unset( $l10n_unloaded[ $domain ] );
+
     $l10n[$domain] = &$mo;
 
@@ -572 +579 @@
  * @since 3.0.0
  *
- * @global array $l10n
+ * @global array $l10n          An array of all currently loaded text domains.
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
  *
  * @param string $domain Text domain. Unique identifier for retrieving translated strings.
@@ -578 +586 @@
  */
 function unload_textdomain( $domain ) {
-    global $l10n;
+    global $l10n, $l10n_unloaded;
+
+    $l10n_unloaded = (array) $l10n_unloaded;
 
     /**
@@ -590 +600 @@
     $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
 
-    if ( $plugin_override )
+    if ( $plugin_override ) {
+        $l10n_unloaded[ $domain ] = true;
+
         return true;
+    }
 
     /**
@@ -604 +617 @@
     if ( isset( $l10n[$domain] ) ) {
         unset( $l10n[$domain] );
+
+        $l10n_unloaded[ $domain ] = true;
+
         return true;
     }
@@ -794 +810 @@
  *
  * @see get_translations_for_domain()
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
  *
  * @param string $domain Text domain. Unique identifier for retrieving translated strings.
@@ -799 +816 @@
  */
 function _load_textdomain_just_in_time( $domain ) {
+    global $l10n_unloaded;
+
+    $l10n_unloaded = (array) $l10n_unloaded;
+
     static $cached_mofiles = null;
 
     // Short-circuit if domain is 'default' which is reserved for core.
-    if ( 'default' === $domain ) {
+    if ( 'default' === $domain || isset( $l10n_unloaded[ $domain ] ) ) {
         return false;
     }

trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php

@@ -23 +23 @@
         wp_clean_themes_cache();
         unset( $GLOBALS['wp_themes'] );
+
+        unset( $GLOBALS['l10n_unloaded'] );
     }
 
@@ -90 +92 @@
 
     /**
-     * @ticket 341142
+     * @ticket 34114
      */
     public function test_get_translations_for_domain_does_not_return_null_if_override_load_textdomain_is_used() {
@@ -101 +103 @@
         $this->assertTrue( $translations instanceof NOOP_Translations );
     }
+
+    /**
+     * @ticket 37113
+     */
+    public function test_should_allow_unloading_of_text_domain() {
+        add_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
+
+        require_once DIR_TESTDATA . '/plugins/internationalized-plugin.php';
+
+        $expected_output_before      = i18n_plugin_test();
+        $is_textdomain_loaded_before = is_textdomain_loaded( 'internationalized-plugin' );
+
+        unload_textdomain( 'internationalized-plugin' );
+        remove_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
+
+        $expected_output_after      = i18n_plugin_test();
+        $is_textdomain_loaded_after = is_textdomain_loaded( 'internationalized-plugin' );
+
+        add_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
+        load_textdomain( 'internationalized-plugin', WP_LANG_DIR . '/plugins/internationalized-plugin-de_DE.mo' );
+
+        $expected_output_final      = i18n_plugin_test();
+        $is_textdomain_loaded_final = is_textdomain_loaded( 'internationalized-plugin' );
+
+        unload_textdomain( 'internationalized-plugin' );
+        remove_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
+
+        // Text domain loaded just in time.
+        $this->assertSame( 'Das ist ein Dummy Plugin', $expected_output_before );
+        $this->assertTrue( $is_textdomain_loaded_before );
+
+        // Text domain unloaded.
+        $this->assertSame( 'This is a dummy plugin', $expected_output_after );
+        $this->assertFalse( $is_textdomain_loaded_after );
+
+        // Text domain loaded manually again.
+        $this->assertSame( 'Das ist ein Dummy Plugin', $expected_output_final );
+        $this->assertTrue( $is_textdomain_loaded_final );
+    }
 }