Changeset 53543

Timestamp:

06/20/2022 10:55:52 PM (3 years ago)

Author:

johnbillion

Message:

I18N: Correct and improve inline docs and tests for functionality related to nooped plurals.

See #55646, #55652

Location:

trunk

Files:

• src/wp-includes/category-template.php (modified) (1 diff)
• src/wp-includes/l10n.php (modified) (3 diffs)
• src/wp-includes/post.php (modified) (1 diff)
• tests/phpunit/tests/l10n.php (modified) (2 diffs)

trunk/src/wp-includes/category-template.php

@@ -824 +824 @@
  *     @type int|bool $filter                     Whether to enable filtering of the final output
  *                                                via {@see 'wp_generate_tag_cloud'}. Default 1.
- *     @type string   $topic_count_text           Nooped plural text from _n_noop() to supply to
+ *     @type array    $topic_count_text           Nooped plural text from _n_noop() to supply to
  *                                                tag counts. Default null.
  *     @type callable $topic_count_text_callback  Callback used to generate nooped plural text for

trunk/src/wp-includes/l10n.php

@@ -588 +588 @@
  *     Array of translation information for the strings.
  *
- *     @type string $0        Singular form to be localized. No longer used.
- *     @type string $1        Plural form to be localized. No longer used.
- *     @type string $singular Singular form to be localized.
- *     @type string $plural   Plural form to be localized.
- *     @type null   $context  Context information for the translators.
- *     @type string $domain   Text domain.
+ *     @type string      $0        Singular form to be localized. No longer used.
+ *     @type string      $1        Plural form to be localized. No longer used.
+ *     @type string      $singular Singular form to be localized.
+ *     @type string      $plural   Plural form to be localized.
+ *     @type null        $context  Context information for the translators.
+ *     @type string|null $domain   Text domain.
  * }
  */
@@ -655 +655 @@
 
 /**
- * Translates and retrieves the singular or plural form of a string that's been registered
+ * Translates and returns the singular or plural form of a string that's been registered
  * with _n_noop() or _nx_noop().
  *
@@ -668 +668 @@
  * @since 3.1.0
  *
- * @param array  $nooped_plural Array with singular, plural, and context keys, usually the result of _n_noop() or _nx_noop().
+ * @param array  $nooped_plural {
+ *     Array that is usually a return value from _n_noop() or _nx_noop().
+ *
+ *     @type string      $singular Singular form to be localized.
+ *     @type string      $plural   Plural form to be localized.
+ *     @type string|null $context  Context information for the translators.
+ *     @type string|null $domain   Text domain.
+ * }
  * @param int    $count         Number of objects.
  * @param string $domain        Optional. Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains
  *                              a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.
- * @return string Either $single or $plural translated text.
+ * @return string Either $singular or $plural translated text.
  */
 function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {

trunk/src/wp-includes/post.php

@@ -1255 +1255 @@
  *     @type bool|string $label                     A descriptive name for the post status marked
  *                                                  for translation. Defaults to value of $post_status.
- *     @type bool|array  $label_count               Descriptive text to use for nooped plurals.
- *                                                  Default array of $label, twice.
+ *     @type array|false $label_count               Nooped plural text from _n_noop() to provide the singular
+ *                                                  and plural forms of the label for counts. Default false
+ *                                                  which means the `$label` argument will be used for both
+ *                                                  the singular and plural forms of this label.
  *     @type bool        $exclude_from_search       Whether to exclude posts with this post status
  *                                                  from search results. Default is value of $internal.

trunk/tests/phpunit/tests/l10n.php

@@ -23 +23 @@
         $nooped_plural = _n_noop( '%s post', '%s posts', $text_domain );
 
-        $this->assertNotEmpty( $nooped_plural['domain'] );
+        $this->assertSame( 'text-domain', $nooped_plural['domain'] );
         $this->assertSame( '%s posts', translate_nooped_plural( $nooped_plural, 0, $text_domain ) );
         $this->assertSame( '%s post', translate_nooped_plural( $nooped_plural, 1, $text_domain ) );
@@ -36 +36 @@
         $nooped_plural = _nx_noop( '%s post', '%s posts', 'my-context', $text_domain );
 
-        $this->assertNotEmpty( $nooped_plural['domain'] );
-        $this->assertNotEmpty( $nooped_plural['context'] );
+        $this->assertSame( 'text-domain', $nooped_plural['domain'] );
+        $this->assertSame( 'my-context', $nooped_plural['context'] );
         $this->assertSame( '%s posts', translate_nooped_plural( $nooped_plural, 0, $text_domain ) );
         $this->assertSame( '%s post', translate_nooped_plural( $nooped_plural, 1, $text_domain ) );