Changeset 57518

Timestamp:

02/01/2024 08:57:03 PM (3 months ago)

Author:

swissspidy

Message:

I18N: Fix plural forms parsing in WP_Translation_File.

Ensures the plural expression from the translation file header is correctly parsed.
Prevents silent failures in the attempt to create the plural form function.

Adds additional tests.

Props Chouby.
See #59656.

Location:

trunk

Files:

• src/wp-includes/l10n/class-wp-translation-file.php (modified) (5 diffs)
• tests/phpunit/data/l10n/plural-complex.mo (added)
• tests/phpunit/data/l10n/plural-complex.php (added)
• tests/phpunit/tests/l10n/wpTranslations.php (modified) (1 diff)

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

@@ -208 +208 @@
 
     /**
-     * Returns the plural form for a count.
+     * Returns the plural form for a given number.
      *
      * @since 6.5.0
@@ -220 +220 @@
         }
 
-        // In case a plural form is specified as a header, but no function included, build one.
         if ( null === $this->plural_forms && isset( $this->headers['plural-forms'] ) ) {
-            $this->plural_forms = $this->make_plural_form_function( $this->headers['plural-forms'] );
+            $expression         = $this->get_plural_expression_from_header( $this->headers['plural-forms'] );
+            $this->plural_forms = $this->make_plural_form_function( $expression );
         }
 
@@ -232 +232 @@
              */
             $result = call_user_func( $this->plural_forms, $number );
+
             return $result;
         }
@@ -240 +241 @@
 
     /**
+     * Returns the plural forms expression as a tuple.
+     *
+     * @since 6.5.0
+     *
+     * @param string $header Plural-Forms header string.
+     * @return string Plural forms expression.
+     */
+    protected function get_plural_expression_from_header( $header ) {
+        if ( preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s+plural\s*=\s*(.+)$/', $header, $matches ) ) {
+            return trim( $matches[2] );
+        }
+
+        return 'n != 1';
+    }
+
+    /**
      * Makes a function, which will return the right translation index, according to the
      * plural forms header.
@@ -248 +265 @@
      * @return callable(int $num): int Plural forms function.
      */
-    public function make_plural_form_function( string $expression ): callable {
+    protected function make_plural_form_function( string $expression ): callable {
         try {
             $handler = new Plural_Forms( rtrim( $expression, ';' ) );

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

@@ -222 +222 @@
     /**
      * @covers ::translate_plural
+     * @covers WP_Translation_File::get_plural_form
+     */
+    public function test_translate_plural_complex() {
+        load_textdomain( 'wp-tests-domain', DIR_TESTDATA . '/l10n/plural-complex.mo' );
+
+        $this->assertSame( '%s razpoložljiva posodobitev', _n( '%s update available', '%s updates available', 101, 'wp-tests-domain' ) ); // 1, 101, 201
+        $this->assertSame( '%s razpoložljivi posodobitvi', _n( '%s update available', '%s updates available', 102, 'wp-tests-domain' ) ); // 2, 102, 202
+        $this->assertSame( '%s razpoložljive posodobitve', _n( '%s update available', '%s updates available', 103, 'wp-tests-domain' ) ); // 3, 4, 103
+        $this->assertSame( '%s razpoložljivih posodobitev', _n( '%s update available', '%s updates available', 5, 'wp-tests-domain' ) ); // 0, 5, 6
+    }
+
+    /**
+     * @covers ::translate_plural
+     * @covers WP_Translation_File::get_plural_form
+     */
+    public function test_translate_plural_complex_php() {
+        load_textdomain( 'wp-tests-domain', DIR_TESTDATA . '/l10n/plural-complex.php' );
+
+        $this->assertSame( '%s razpoložljiva posodobitev', _n( '%s update available', '%s updates available', 101, 'wp-tests-domain' ) ); // 1, 101, 201
+        $this->assertSame( '%s razpoložljivi posodobitvi', _n( '%s update available', '%s updates available', 102, 'wp-tests-domain' ) ); // 2, 102, 202
+        $this->assertSame( '%s razpoložljive posodobitve', _n( '%s update available', '%s updates available', 103, 'wp-tests-domain' ) ); // 3, 4, 103
+        $this->assertSame( '%s razpoložljivih posodobitev', _n( '%s update available', '%s updates available', 5, 'wp-tests-domain' ) ); // 0, 5, 6
+    }
+
+    /**
+     * @covers WP_Translation_File::get_plural_form
+     */
+    public function test_get_plural_form() {
+        $moe = WP_Translation_File::create( DIR_TESTDATA . '/l10n/plural-complex.mo' );
+
+        $this->assertSame( 0, $moe->get_plural_form( 1 ) );
+        $this->assertSame( 0, $moe->get_plural_form( 101 ) );
+        $this->assertSame( 0, $moe->get_plural_form( 201 ) );
+        $this->assertSame( 1, $moe->get_plural_form( 2 ) );
+        $this->assertSame( 1, $moe->get_plural_form( 102 ) );
+        $this->assertSame( 1, $moe->get_plural_form( 202 ) );
+        $this->assertSame( 2, $moe->get_plural_form( 3 ) );
+        $this->assertSame( 2, $moe->get_plural_form( 4 ) );
+        $this->assertSame( 2, $moe->get_plural_form( 103 ) );
+        $this->assertSame( 3, $moe->get_plural_form( 0 ) );
+        $this->assertSame( 3, $moe->get_plural_form( 5 ) );
+        $this->assertSame( 3, $moe->get_plural_form( 6 ) );
+    }
+
+    /**
+     * @covers ::translate_plural
      */
     public function test_translate_plural_missing() {