Changeset 25565

Timestamp:

09/23/2013 12:37:34 AM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/l10n.php.

Props Nao.
Fixes #25382.

File:

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

trunk/src/wp-includes/l10n.php

@@ -28 +28 @@
 
     if ( isset( $locale ) )
+        /**
+         * Filter WordPress install's locale ID.
+         *
+         * @since 1.5.2
+         *
+         * @param string $locale The locale ID.
+         */
         return apply_filters( 'locale', $locale );
 
@@ -47 +54 @@
         $locale = 'en_US';
 
+    // duplicate_hook
     return apply_filters( 'locale', $locale );
 }
@@ -65 +73 @@
 function translate( $text, $domain = 'default' ) {
     $translations = get_translations_for_domain( $domain );
-    return apply_filters( 'gettext', $translations->translate( $text ), $text, $domain );
+    $translations = $translations->translate( $text );
+    /**
+     * Filter text with its translation.
+     *
+     * @since 2.0.11
+     *
+     * @param string $translations Translated text.
+     * @param string $text         Text to translate.
+     * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
+     */
+    return apply_filters( 'gettext', $translations, $text, $domain );
 }
 
@@ -102 +120 @@
 function translate_with_gettext_context( $text, $context, $domain = 'default' ) {
     $translations = get_translations_for_domain( $domain );
-    return apply_filters( 'gettext_with_context', $translations->translate( $text, $context ), $text, $context, $domain );
+    $translations = $translations->translate( $text, $context );
+    /**
+     * Filter text with its translation based on context information.
+     *
+     * @since 2.8.0
+     *
+     * @param string $translations 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.
+     */
+    return apply_filters( 'gettext_with_context', $translations, $text, $context, $domain );
 }
 
@@ -269 +298 @@
     $translations = get_translations_for_domain( $domain );
     $translation = $translations->translate_plural( $single, $plural, $number );
+    /**
+     * Filter text with its translation when plural option is available.
+     *
+     * @since 2.2.0
+     *
+     * @param string $translation Translated text.
+     * @param string $single      The text that will be used if $number is 1.
+     * @param string $plural      The text that will be used if $number is not 1.
+     * @param string $number      The number to compare against to use either $single or $plural.
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
+     */
     return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
 }
@@ -289 +329 @@
     $translations = get_translations_for_domain( $domain );
     $translation = $translations->translate_plural( $single, $plural, $number, $context );
+    /**
+     * Filter text with its translation while plural option and context are available.
+     *
+     * @since 2.8.0
+     *
+     * @param string $translation Translated text.
+     * @param string $single      The text that will be used if $number is 1.
+     * @param string $plural      The text that will be used if $number is not 1.
+     * @param string $number      The number to compare against to use either $single or $plural.
+     * @param string $context     Context information for the translators.
+     * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
+     */
     return apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain );
 }
@@ -368 +420 @@
     global $l10n;
 
+    /**
+     * Filter text domain and/or MO file path for loading translations.
+     *
+     * @since 2.9.0
+     *
+     * @param boolean        Whether to override the text domain. Default false.
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     * @param string $mofile Path to the MO file.
+     */
     $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
 
@@ -374 +435 @@
     }
 
+    /**
+     * Fires before the MO translation file is loaded.
+     *
+     * @since 2.9.0
+     *
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     * @param string $mofile Path to the .mo file.
+     */
     do_action( 'load_textdomain', $domain, $mofile );
 
+    /**
+     * Filter MO file path for loading translations for a specific text domain.
+     *
+     * @since 2.9.0
+     *
+     * @param string $mofile Path to the MO file.
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     */
     $mofile = apply_filters( 'load_textdomain_mofile', $mofile, $domain );
 
@@ -402 +479 @@
     global $l10n;
 
+    /**
+     * Filter text domain for loading translation.
+     *
+     * @since 3.0.0
+     *
+     * @param boolean        Whether to override unloading the text domain. Default false.
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     */
     $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
 
@@ -407 +492 @@
         return true;
 
+    /**
+     * Fires before the text domain is unloaded.
+     *
+     * @since 3.0.0
+     *
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     */
     do_action( 'unload_textdomain', $domain );
 
@@ -459 +551 @@
  */
 function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
-    $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
+    $locale = get_locale();
+    /**
+     * Filter a plugin's locale.
+     *
+     * @since 3.0.0
+     *
+     * @param string $locale The plugin's current locale.
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     */
+    $locale = apply_filters( 'plugin_locale', $locale, $domain );
 
     if ( false !== $plugin_rel_path ) {
@@ -491 +592 @@
  */
 function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
+    // duplicate_hook
     $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
     $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
@@ -520 +622 @@
  */
 function load_theme_textdomain( $domain, $path = false ) {
-    $locale = apply_filters( 'theme_locale', get_locale(), $domain );
+    $locale = get_locale();
+    /**
+     * Filter a theme's locale.
+     *
+     * @since 3.0.0
+     *
+     * @param string $locale The theme's current locale.
+     * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+     */
+    $locale = apply_filters( 'theme_locale', $locale, $domain );
 
     if ( ! $path )