Changeset 48131 for trunk/src/wp-includes/l10n.php

Timestamp:

06/23/2020 04:41:02 AM (4 years ago)

Author:

whyisjake

Message:

I18N: Introduce domain specific i18n gettext hooks.

Adding context to allow for more specific targeting. New hooks:

• gettext-{$domain}
• gettext_with_context-{$domain}
• ngettext-{$domain}
• ngettext_with_context-{$domain}

Fixes #49518.

Props geminilabs, garrett-eclipse, davidbaumwald, johnbillion, whyisjake.

File:

• trunk/src/wp-includes/l10n.php (modified) (9 diffs)

trunk/src/wp-includes/l10n.php

@@ -166 +166 @@
  *
  * @since 2.2.0
+ * @since 5.5.0 Introduced gettext-{$domain} filter.
  *
  * @param string $text   Text to translate.
@@ -185 +186 @@
      * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
      */
-    return apply_filters( 'gettext', $translation, $text, $domain );
+    $translation = apply_filters( 'gettext', $translation, $text, $domain );
+
+    /**
+     * Filters text with its translation for a domain.
+     *
+     * @since 5.5.0
+     *
+     * @param string $translation  Translated text.
+     * @param string $text         Text to translate.
+     */
+    return apply_filters( 'gettext-' . $domain, $translation, $text );
 }
 
@@ -216 +227 @@
  *
  * @since 2.8.0
+ * @since 5.5.0 Introduced gettext_with_context-{$domain} filter.
  *
  * @param string $text    Text to translate.
@@ -226 +238 @@
     $translations = get_translations_for_domain( $domain );
     $translation  = $translations->translate( $text, $context );
+
     /**
      * Filters text with its translation based on context information.
@@ -236 +249 @@
      * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
      */
-    return apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );
+    $translation = apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );
+
+    /**
+     * Filters text with its translation based on context information for a domain.
+     *
+     * @since 5.5.0
+     *
+     * @param string $translation  Translated text.
+     * @param string $text         Text to translate.
+     * @param string $context      Context information for the translators.
+     */
+    return apply_filters( 'gettext_with_context-' . $domain, $translation, $text, $context );
 }
 
@@ -420 +444 @@
  *
  * @since 2.8.0
+ * @since 5.5.0 Introduced ngettext-{$domain} filter.
  *
  * @param string $single The text to be used if the number is singular.
@@ -443 +468 @@
      * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
      */
-    return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
+    $translation = apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
+
+    /**
+     * Filters the singular or plural form of a string for a domain.
+     *
+     * @since 5.5.0
+     *
+     * @param string $translation Translated text.
+     * @param string $single      The text to be used if the number is singular.
+     * @param string $plural      The text to be used if the number is plural.
+     * @param string $number      The number to compare against to use either the singular or plural form.
+     */
+    return apply_filters( 'ngettext-' . $domain, $translation, $single, $plural, $number );
 }
 
@@ -460 +497 @@
  *
  * @since 2.8.0
+ * @since 5.5.0 Introduced ngettext_with_context-{$domain} filter.
  *
  * @param string $single  The text to be used if the number is singular.
@@ -485 +523 @@
      * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
      */
-    return apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain );
+    $translation = apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain );
+
+    /**
+     * Filters the singular or plural form of a string with gettext context for a domain.
+     *
+     * @since 5.5.0
+     *
+     * @param string $translation Translated text.
+     * @param string $single      The text to be used if the number is singular.
+     * @param string $plural      The text to be used if the number is plural.
+     * @param string $number      The number to compare against to use either the singular or plural form.
+     * @param string $context     Context information for the translators.
+     */
+    return apply_filters( 'ngettext_with_context-' . $domain, $translation, $single, $plural, $number, $context );
 }