<!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>[57386] trunk: I18N: Improve singular lookup of pluralized strings.</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/57386">57386</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/57386","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-30 13:59:46 +0000 (Tue, 30 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 singular lookup of pluralized strings.
Ensures that looking up a singular that is also used as a pluralized string works as expected.
This improves compatibility for cases where for example both `__( 'Product' )` and `_n( 'Product', 'Products', num )` are used in a project, where both will use the same translation for the singular version.
Although such usage is not really recommended nor documented, it must continue to work in the new i18n library in order to maintain backward compatibility and maintain expected behavior.
See <a href="https://core.trac.wordpress.org/ticket/59656">#59656</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesl10nclasswptranslationfilephp">trunk/src/wp-includes/l10n/class-wp-translation-file.php</a></li>
<li><a href="#trunktestsphpunitdatal10nexamplesimplemo">trunk/tests/phpunit/data/l10n/example-simple.mo</a></li>
<li><a href="#trunktestsphpunitdatal10nexamplesimplephp">trunk/tests/phpunit/data/l10n/example-simple.php</a></li>
<li><a href="#trunktestsphpunitdatal10nexamplesimplepo">trunk/tests/phpunit/data/l10n/example-simple.po</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="trunksrcwpincludesl10nclasswptranslationfilephp"></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-file.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-file.php 2024-01-30 12:55:53 UTC (rev 57385)
+++ trunk/src/wp-includes/l10n/class-wp-translation-file.php 2024-01-30 13:59:46 UTC (rev 57386)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,7 +203,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->parse_file();
</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">- return $this->entries[ $text ] ?? false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $this->entries[ $text ] ) ) {
+ return $this->entries[ $text ];
+ }
+
+ /*
+ * Handle cases where a pluralized string is only used as a singular one.
+ * For example, when both __( 'Product' ) and _n( 'Product', 'Products' )
+ * are used, the entry key will have the format "ProductNULProducts".
+ * Fall back to looking up just "Product" to support this edge case.
+ */
+ foreach( $this->entries as $key => $value ) {
+ if ( str_starts_with( $key, $text . "\0" ) ) {
+ $parts = explode( "\0", $value );
+ return $parts[0];
+ }
+ }
+
+ return false;
</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="trunktestsphpunitdatal10nexamplesimplemo"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/l10n/example-simple.mo</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<a id="trunktestsphpunitdatal10nexamplesimplephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/l10n/example-simple.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/l10n/example-simple.php 2024-01-30 12:55:53 UTC (rev 57385)
+++ trunk/tests/phpunit/data/l10n/example-simple.php 2024-01-30 13:59:46 UTC (rev 57386)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,5 +6,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'contextoriginal with context' => ['translation with context'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'plural0' . "\0" . 'plural1' => ['translation0', 'translation1'],
</span><span class="cx" style="display: block; padding: 0 10px"> 'contextplural0 with context' . "\0" . 'plural1 with context' => ['translation0 with context', 'translation1 with context'],
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'Product' . "\0" . 'Products' => 'Produkt' . "\0" . 'Produkte',
</ins><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="trunktestsphpunitdatal10nexamplesimplepo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/l10n/example-simple.po</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/l10n/example-simple.po 2024-01-30 12:55:53 UTC (rev 57385)
+++ trunk/tests/phpunit/data/l10n/example-simple.po 2024-01-30 13:59:46 UTC (rev 57386)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,4 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> msgstr[0] "translation0 with context"
</span><span class="cx" style="display: block; padding: 0 10px"> msgstr[1] "translation1 with context"
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+msgid "Product"
+msgid_plural "Products"
+msgstr[0] "Produkt"
+msgstr[1] "Produkte"
</ins></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-30 12:55:53 UTC (rev 57385)
+++ trunk/tests/phpunit/tests/l10n/wpTranslationsConvert.php 2024-01-30 13:59:46 UTC (rev 57386)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -173,6 +173,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::translate_plural
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::locate_translation
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::get_files
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @covers WP_Translation_File::translate
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_simple_example_files
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,6 +199,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'translation1 with context', $controller->translate_plural( array( 'plural0 with context', 'plural1 with context' ), 0, 'context', 'unittest' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'translation0 with context', $controller->translate_plural( array( 'plural0 with context', 'plural1 with context' ), 1, 'context', 'unittest' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'translation1 with context', $controller->translate_plural( array( 'plural0 with context', 'plural1 with context' ), 2, 'context', 'unittest' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->assertSame( 'Produkt', $controller->translate( 'Product', '', 'unittest' ) );
+ $this->assertSame( 'Produkt', $controller->translate_plural( array( 'Product', 'Products' ), 1, '', 'unittest' ) );
+ $this->assertSame( 'Produkte', $controller->translate_plural( array( 'Product', 'Products' ), 2, '', 'unittest' ) );
</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>
</div>
</body>
</html>