Changeset 48136

Timestamp:

06/23/2020 10:00:36 AM (5 years ago)

Author:

SergeyBiryukov

Message:

I18N: Use underscores instead of dashes and interpolation instead of concatenation in domain-specific gettext hooks, per the coding standards:

• gettext_{$domain}
• gettext_with_context_{$domain}
• ngettext_{$domain}
• ngettext_with_context_{$domain}

Additionally:

• Pass $domain parameter to the new hooks, for consistency with their pre-existing counterparts.
• Update documentation to explain the dynamic portion of the filter, for consistency with other dynamic hooks in core.

Follow-up to [48131].

Props swissspidy, knutsp, TimothyBlynJacobs, SergeyBiryukov.
Fixes #49518.

File:

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

trunk/src/wp-includes/l10n.php

@@ -130 +130 @@
      */
     $determined_locale = apply_filters( 'pre_determine_locale', null );
+
     if ( ! empty( $determined_locale ) && is_string( $determined_locale ) ) {
         return $determined_locale;
@@ -182 +183 @@
      * @since 2.0.11
      *
-     * @param string $translation  Translated text.
-     * @param string $text         Text to translate.
-     * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
+     * @param string $translation Translated text.
+     * @param string $text        Text to translate.
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
      */
     $translation = apply_filters( 'gettext', $translation, $text, $domain );
@@ -191 +192 @@
      * Filters text with its translation for a domain.
      *
+     * The dynamic portion of the hook, `$domain`, refers to the text domain.
+     *
      * @since 5.5.0
      *
-     * @param string $translation  Translated text.
-     * @param string $text         Text to translate.
-     */
-    return apply_filters( 'gettext-' . $domain, $translation, $text );
+     * @param string $translation Translated text.
+     * @param string $text        Text to translate.
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
+     */
+    $translation = apply_filters( "gettext_{$domain}", $translation, $text, $domain );
+
+    return $translation;
 }
 
@@ -244 +250 @@
      * @since 2.8.0
      *
-     * @param string $translation  Translated text.
-     * @param string $text         Text to translate.
-     * @param string $context      Context information for the translators.
-     * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
+     * @param string $translation Translated text.
+     * @param string $text        Text to translate.
+     * @param string $context     Context information for the translators.
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
      */
     $translation = apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );
@@ -254 +260 @@
      * Filters text with its translation based on context information for a domain.
      *
+     * The dynamic portion of the hook, `$domain`, refers to the text 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 );
+     * @param string $translation Translated text.
+     * @param string $text        Text to translate.
+     * @param string $context     Context information for the translators.
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
+     */
+    $translation = apply_filters( "gettext_with_context_{$domain}", $translation, $text, $context, $domain );
+
+    return $translation;
 }
 
@@ -473 +484 @@
      * Filters the singular or plural form of a string for a domain.
      *
+     * The dynamic portion of the hook, `$domain`, refers to the text domain.
+     *
      * @since 5.5.0
      *
@@ -479 +492 @@
      * @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 );
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
+     */
+    $translation = apply_filters( "ngettext_{$domain}", $translation, $single, $plural, $number, $domain );
+
+    return $translation;
 }
 
@@ -528 +544 @@
      * Filters the singular or plural form of a string with gettext context for a domain.
      *
+     * The dynamic portion of the hook, `$domain`, refers to the text domain.
+     *
      * @since 5.5.0
      *
@@ -535 +553 @@
      * @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 );
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
+     */
+    $translation = apply_filters( "ngettext_with_context_{$domain}", $translation, $single, $plural, $number, $context, $domain );
+
+    return $translation;
 }
 
@@ -692 +713 @@
     $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
 
-    if ( true == $plugin_override ) {
+    if ( true === (bool) $plugin_override ) {
         unset( $l10n_unloaded[ $domain ] );