<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[37855] trunk: I18N: Enable unloading of text domains that have been loaded just in time.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/37855">37855</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37855","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-23 14:47:44 +0000 (Thu, 23 Jun 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>I18N: Enable unloading of text domains that have been loaded just in time.
<a href="https://core.trac.wordpress.org/changeset/37415">[37415]</a> 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 <a href="https://core.trac.wordpress.org/ticket/37113">#37113</a>. See <a href="https://core.trac.wordpress.org/ticket/34114">#34114</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunktestsphpunittestsl10nloadTextdomainJustInTimephp">trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesl10nphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/l10n.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n.php 2016-06-23 14:31:15 UTC (rev 37854)
+++ trunk/src/wp-includes/l10n.php 2016-06-23 14:47:44 UTC (rev 37855)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -509,15 +509,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $l10n
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $mofile Path to the .mo file.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function load_textdomain( $domain, $mofile ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $l10n;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $l10n, $l10n_unloaded;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $l10n_unloaded = (array) $l10n_unloaded;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to override the .mo file loading.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -530,6 +533,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( true == $plugin_override ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $l10n_unloaded[ $domain ] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -561,6 +566,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $l10n[$domain] ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $mo->merge_with( $l10n[$domain] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $l10n_unloaded[ $domain ] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $l10n[$domain] = &$mo;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -571,14 +578,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @global array $l10n
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether textdomain was unloaded.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function unload_textdomain( $domain ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- global $l10n;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $l10n, $l10n_unloaded;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $l10n_unloaded = (array) $l10n_unloaded;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to override the text domain unloading.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -589,8 +599,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $plugin_override )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $plugin_override ) {
+ $l10n_unloaded[ $domain ] = true;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires before the text domain is unloaded.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -603,6 +616,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $l10n[$domain] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $l10n[$domain] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $l10n_unloaded[ $domain ] = true;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -793,15 +809,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see get_translations_for_domain()
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $domain Text domain. Unique identifier for retrieving translated strings.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True when the textdomain is successfully loaded, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function _load_textdomain_just_in_time( $domain ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> static $cached_mofiles = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Short-circuit if domain is 'default' which is reserved for core.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'default' === $domain ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'default' === $domain || isset( $l10n_unloaded[ $domain ] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nloadTextdomainJustInTimephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php 2016-06-23 14:31:15 UTC (rev 37854)
+++ trunk/tests/phpunit/tests/l10n/loadTextdomainJustInTime.php 2016-06-23 14:47:44 UTC (rev 37855)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,6 +22,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'template_root', array( $this, 'filter_theme_root' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_clean_themes_cache();
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $GLOBALS['wp_themes'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ unset( $GLOBALS['l10n_unloaded'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> function tearDown() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,7 +91,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ticket 341142
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 34114
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_translations_for_domain_does_not_return_null_if_override_load_textdomain_is_used() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'locale', array( $this, 'filter_set_locale_to_german' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -100,4 +102,43 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $translations instanceof NOOP_Translations );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @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 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>