<!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>[57339] trunk: I18N: Improve edge case handling in `WP_Translation_Controller`.</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 { white-space: pre-line; 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/57339">57339</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/57339","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>2024-01-23 15:13:32 +0000 (Tue, 23 Jan 2024)</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: Improve edge case handling in `WP_Translation_Controller`.
Prevents PHP warnings for possibly undefined array keys.
Also fixes incorrect `@covers` annotations.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/57337">[57337]</a>.
See <a href="https://core.trac.wordpress.org/ticket/59656">#59656</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesl10nclasswptranslationcontrollerphp">trunk/src/wp-includes/l10n/class-wp-translation-controller.php</a></li>
<li><a href="#trunksrcwpincludesl10nphp">trunk/src/wp-includes/l10n.php</a></li>
<li><a href="#trunktestsphpunittestsl10nwpTranslationControllerphp">trunk/tests/phpunit/tests/l10n/wpTranslationController.php</a></li>
<li><a href="#trunktestsphpunittestsl10nwpTranslationsConvertphp">trunk/tests/phpunit/tests/l10n/wpTranslationsConvert.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesl10nclasswptranslationcontrollerphp"></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/class-wp-translation-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/l10n/class-wp-translation-controller.php 2024-01-23 14:01:59 UTC (rev 57338)
+++ trunk/src/wp-includes/l10n/class-wp-translation-controller.php 2024-01-23 15:13:32 UTC (rev 57339)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,11 +151,13 @@
</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"> if ( null !== $locale ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $i => $moe ) {
- if ( $file === $moe || $file === $moe->get_file() ) {
- unset( $this->loaded_translations[ $locale ][ $textdomain ][ $i ] );
- unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
- return true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+ foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $i => $moe ) {
+ if ( $file === $moe || $file === $moe->get_file() ) {
+ unset( $this->loaded_translations[ $locale ][ $textdomain ][ $i ] );
+ unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+ return true;
+ }
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,6 +165,10 @@
</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"> foreach ( $this->loaded_translations as $l => $domains ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $domains[ $textdomain ] ) ) {
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $domains[ $textdomain ] as $i => $moe ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $file === $moe || $file === $moe->get_file() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $this->loaded_translations[ $l ][ $textdomain ][ $i ] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -185,18 +191,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True on success, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function unload_textdomain( string $textdomain = 'default', string $locale = null ): bool {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unloaded = false;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( null !== $locale ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $moe ) {
- unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {
+ $unloaded = true;
+ foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $moe ) {
+ unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );
+ }
</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"> unset( $this->loaded_translations[ $locale ][ $textdomain ] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return true;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $unloaded;
</ins><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">- $unloaded = false;
-
</del><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->loaded_translations as $l => $domains ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $domains[ $textdomain ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span></span></pre></div>
<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 2024-01-23 14:01:59 UTC (rev 57338)
+++ trunk/src/wp-includes/l10n.php 2024-01-23 15:13:32 UTC (rev 57339)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -821,7 +821,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'mo' !== $preferred_format ) {
</span><span class="cx" style="display: block; padding: 0 10px"> array_unshift(
</span><span class="cx" style="display: block; padding: 0 10px"> $translation_files,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- substr_replace( $mofile, ".l10n.$preferred_format", - strlen( $preferred_format ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ substr_replace( $mofile, ".l10n.$preferred_format", - strlen( '.mo' ) )
</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">
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nwpTranslationControllerphp"></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/wpTranslationController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/wpTranslationController.php 2024-01-23 14:01:59 UTC (rev 57338)
+++ trunk/tests/phpunit/tests/l10n/wpTranslationController.php 2024-01-23 15:13:32 UTC (rev 57339)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,6 +110,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_load_textdomain_prefers_php_files_by_default() {
+ $load_successful = load_textdomain( 'wp-tests-domain', DIR_TESTDATA . '/pomo/simple.mo' );
+
+ $instance = WP_Translation_Controller::instance();
+
+ $is_loaded = $instance->is_textdomain_loaded( 'wp-tests-domain', 'en_US' );
+
+ $unload_mo = $instance->unload_file( DIR_TESTDATA . '/pomo/simple.mo', 'wp-tests-domain' );
+ $unload_php = $instance->unload_file( DIR_TESTDATA . '/pomo/simple.l10n.php', 'wp-tests-domain' );
+
+ $unload_successful = unload_textdomain( 'wp-tests-domain' );
+
+ $this->assertTrue( $load_successful, 'Translation not successfully loaded' );
+ $this->assertTrue( $is_loaded );
+ $this->assertFalse( $unload_mo );
+ $this->assertTrue( $unload_php );
+ $this->assertTrue( $unload_successful );
+ }
+
+ /**
+ * @covers ::load_textdomain
+ *
+ * @return void
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_load_textdomain_reads_php_files_if_filtered_format_is_unsupported() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter(
</span><span class="cx" style="display: block; padding: 0 10px"> 'translation_file_format',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -297,6 +321,21 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_file
+ * @covers ::unload_textdomain
+ *
+ * @return void
+ */
+ public function test_unload_non_existent_files_and_textdomains() {
+ $controller = new WP_Translation_Controller();
+ $this->assertFalse( $controller->unload_textdomain( 'foobarbaz' ) );
+ $this->assertFalse( $controller->unload_textdomain( 'foobarbaz', 'es_ES' ) );
+ $this->assertFalse( $controller->unload_textdomain( 'default', 'es_ES' ) );
+ $this->assertFalse( $controller->unload_file( DIR_TESTDATA . '/l10n/fa_IR.mo' ) );
+ $this->assertFalse( $controller->unload_file( DIR_TESTDATA . '/l10n/fa_IR.mo', 'es_ES' ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers ::load_textdomain
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::unload_textdomain
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsl10nwpTranslationsConvertphp"></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/wpTranslationsConvert.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/l10n/wpTranslationsConvert.php 2024-01-23 14:01:59 UTC (rev 57338)
+++ trunk/tests/phpunit/tests/l10n/wpTranslationsConvert.php 2024-01-23 15:13:32 UTC (rev 57339)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,7 +28,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">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_textdomain
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,7 +40,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"> * @covers ::load
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_textdomain
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers ::is_textdomain_loaded
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::locate_translation
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -62,7 +62,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">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_file
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers WP_Translation_File::get_file
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -77,7 +77,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">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_textdomain
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers ::is_textdomain_loaded
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,7 +235,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"> * @covers ::load
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_file
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers ::is_textdomain_loaded
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate_plural
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -289,7 +289,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::set_locale
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::get_locale
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::load
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_file
</ins><span class="cx" style="display: block; padding: 0 10px"> * @covers ::is_textdomain_loaded
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate_plural
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -333,7 +333,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">- * @covers ::unload
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers ::unload_textdomain
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -411,7 +411,6 @@
</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"> * @covers ::load
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @covers ::unload
</del><span class="cx" style="display: block; padding: 0 10px"> * @covers ::is_textdomain_loaded
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate_plural
</span></span></pre>
</div>
</div>
</body>
</html>