Changeset 57513

Timestamp:

02/01/2024 11:43:21 AM (15 months ago)

Author:

swissspidy

Message:

I18N: Improve singular lookup of pluralized strings.

Ensures that string lookup in MO files only uses the singular string.

This matches expected behavior with gettext files and 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. Maintains backward compatibility and feature parity with the pomo library and the PHP translation file format.

Replaces [57386], which was reverted in [57505], with a more accurate and performant solution.

See #59656.

Location:

trunk

Files:

• src/wp-includes/l10n/class-wp-translation-file-mo.php (modified) (1 diff)
• src/wp-includes/l10n/class-wp-translation-file-php.php (modified) (1 diff)
• src/wp-includes/l10n/class-wp-translations.php (modified) (1 diff)
• tests/phpunit/data/l10n/example-simple.php (modified) (1 diff)
• tests/phpunit/tests/l10n/wpTranslations.php (modified) (2 diffs)
• tests/phpunit/tests/l10n/wpTranslationsConvert.php (modified) (1 diff)

trunk/src/wp-includes/l10n/class-wp-translation-file-mo.php

@@ -162 +162 @@
                 }
             } else {
-                $this->entries[ (string) $original ] = $translation;
+                /*
+                 * In MO files, the key normally contains both singular and plural versions.
+                 * However, this just adds the singular string for lookup,
+                 * which caters for cases where both __( 'Product' ) and _n( 'Product', 'Products' )
+                 * are used and the translation is expected to be the same for both.
+                 */
+                $parts = explode( "\0", (string) $original );
+
+                $this->entries[ $parts[0] ] = $translation;
             }
         }

trunk/src/wp-includes/l10n/class-wp-translation-file-php.php

@@ -29 +29 @@
 
         if ( isset( $result['messages'] ) && is_array( $result['messages'] ) ) {
-            foreach ( $result['messages'] as $singular => $translations ) {
-                if ( is_array( $translations ) ) {
-                    $this->entries[ $singular ] = implode( "\0", $translations );
-                } elseif ( is_string( $translations ) ) {
-                    $this->entries[ $singular ] = $translations;
-                }
+            foreach ( $result['messages'] as $original => $translation ) {
+                $this->entries[ (string) $original ] = $translation;
             }
             unset( $result['messages'] );

trunk/src/wp-includes/l10n/class-wp-translations.php

@@ -96 +96 @@
         }
 
-        // Look for plural original.
-        $parts           = explode( "\0", $original );
-        $entry->singular = $parts[0];
-        if ( isset( $parts[1] ) ) {
-            $entry->is_plural = true;
-            $entry->plural    = $parts[1];
-        }
+        $entry->singular     = $original;
+        $entry->translations = explode( "\0", $translations );
+        $entry->is_plural    = count( $entry->translations ) > 1;
 
-        $entry->translations = explode( "\0", $translations );
         return $entry;
     }

trunk/tests/phpunit/data/l10n/example-simple.php

@@ -3 +3 @@
     'messages' =>
         [
-            'original' => ['translation'],
-            'contextoriginal with context' => ['translation with context'],
-            'plural0' . "\0" . 'plural1' => ['translation0', 'translation1'],
-            'contextplural0 with context' . "\0" . 'plural1 with context' => ['translation0 with context', 'translation1 with context'],
-            'Product' . "\0" . 'Products' => 'Produkt' . "\0" . 'Produkte',
+            'original' => 'translation',
+            'contextoriginal with context' => 'translation with context',
+            'plural0' => 'translation0'  . "\0" . 'translation1',
+            'contextplural0 with context' => 'translation0 with context' . "\0" . 'translation1 with context',
+            'Product' => 'Produkt' . "\0" . 'Produkte',
         ],
 ];

trunk/tests/phpunit/tests/l10n/wpTranslations.php

@@ -72 +72 @@
                 new Translation_Entry(
                     array(
+                        'is_plural'    => true,
                         'singular'     => 'one dragon',
-                        'plural'       => '%d dragons',
                         'translations' => array(
                             'oney dragoney',
@@ -120 +120 @@
                         'is_plural'    => true,
                         'singular'     => 'one dragon',
-                        'plural'       => '%d dragons',
                         'context'      => 'dragonland',
                         'translations' => array(

trunk/tests/phpunit/tests/l10n/wpTranslationsConvert.php

@@ -200 +200 @@
         $this->assertSame( 'translation0 with context', $controller->translate_plural( array( 'plural0 with context', 'plural1 with context' ), 1, 'context', 'unittest' ) );
         $this->assertSame( 'translation1 with context', $controller->translate_plural( array( 'plural0 with context', 'plural1 with context' ), 2, 'context', 'unittest' ) );
+
+        $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' ) );
     }