WordPress.org

Make WordPress Core

Ticket #25382: 25382.2.diff

File 25382.2.diff, 6.5 KB (added by DrewAPicture, 8 years ago)

With functional doc changes removed

  • src/wp-includes/l10n.php

     
    2727        global $locale;
    2828
    2929        if ( isset( $locale ) )
     30                /**
     31                 * Filter WordPress install's locale ID.
     32                 *
     33                 * @since 1.5.2
     34                 *
     35                 * @param string $locale The locale id.
     36                 */
    3037                return apply_filters( 'locale', $locale );
    3138
    3239        // WPLANG is defined in wp-config.
     
    4653        if ( empty( $locale ) )
    4754                $locale = 'en_US';
    4855
     56        // duplicate_hook
    4957        return apply_filters( 'locale', $locale );
    5058}
    5159
     
    6472 */
    6573function translate( $text, $domain = 'default' ) {
    6674        $translations = get_translations_for_domain( $domain );
     75        /**
     76         * Filter text with its translation.
     77         *
     78         * @since 2.0.11
     79         *
     80         * @param string $translations Translated text.
     81         * @param string $text         Text to translate.
     82         * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
     83         */
    6784        return apply_filters( 'gettext', $translations->translate( $text ), $text, $domain );
    6885}
    6986
     
    101118 */
    102119function translate_with_gettext_context( $text, $context, $domain = 'default' ) {
    103120        $translations = get_translations_for_domain( $domain );
     121        /**
     122         * Filter text with its translation based on context information.
     123         *
     124         * @since 2.8.0
     125         *
     126         * @param string $translations Translated text.
     127         * @param string $text         Text to translate.
     128         * @param string $context      Context information for the translators.
     129         * @param string $domain       Text domain. Unique identifier for retrieving translated strings.
     130         */
    104131        return apply_filters( 'gettext_with_context', $translations->translate( $text, $context ), $text, $context, $domain );
    105132}
    106133
     
    268295function _n( $single, $plural, $number, $domain = 'default' ) {
    269296        $translations = get_translations_for_domain( $domain );
    270297        $translation = $translations->translate_plural( $single, $plural, $number );
     298        /**
     299         * Filter text with its translation when plural option is available.
     300         *
     301         * @since 2.2.0
     302         *
     303         * @param string $translation Translated text.
     304         * @param string $single      The text that will be used if $number is 1.
     305         * @param string $plural      The text that will be used if $number is not 1.
     306         * @param string $number      The number to compare against to use either $single or $plural.
     307         * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
     308         */
    271309        return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
    272310}
    273311
     
    288326function _nx($single, $plural, $number, $context, $domain = 'default') {
    289327        $translations = get_translations_for_domain( $domain );
    290328        $translation = $translations->translate_plural( $single, $plural, $number, $context );
     329        /**
     330         * Filter text with its translation while plural option and context are available.
     331         *
     332         * @since 2.8.0
     333         *
     334         * @param string $translation Translated text.
     335         * @param string $single      The text that will be used if $number is 1.
     336         * @param string $plural      The text that will be used if $number is not 1.
     337         * @param string $number      The number to compare against to use either $single or $plural.
     338         * @param string $context     Context information for the translators.
     339         * @param string $domain      Text domain. Unique identifier for retrieving translated strings.
     340         */
    291341        return apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain );
    292342}
    293343
     
    367417function load_textdomain( $domain, $mofile ) {
    368418        global $l10n;
    369419
     420        /**
     421         * Filter text domain and/or MO file path for loading translations.
     422         *
     423         * @since 2.9.0
     424         *
     425         * @param boolean        Whether to override the textomain. Default false.
     426         * @param string $domain Text domain. Unique identifier for retrieving translated strings.
     427         * @param string $mofile Path to the MO file.
     428         */
    370429        $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
    371430
    372431        if ( true == $plugin_override ) {
     
    375434
    376435        do_action( 'load_textdomain', $domain, $mofile );
    377436
     437        /**
     438         * Filter MO file path for loading translations for a specific text domain.
     439         *
     440         * @since 2.9.0
     441         *
     442         * @param string $mofile Path to the MO file.
     443         * @param string $domain Text domain. Unique identifier for retrieving translated strings.
     444         */
    378445        $mofile = apply_filters( 'load_textdomain_mofile', $mofile, $domain );
    379446
    380447        if ( !is_readable( $mofile ) ) return false;
     
    401468function unload_textdomain( $domain ) {
    402469        global $l10n;
    403470
     471        /**
     472         * Filter text domain for loading translation.
     473         *
     474         * @since 3.0.0
     475         *
     476         * @param boolean        Whether to override unloading the text domain. Default false.
     477         * @param string $domain Text domain. Unique identifier for retrieving translated strings.
     478         */
    404479        $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
    405480
    406481        if ( $plugin_override )
     
    458533 * @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
    459534 */
    460535function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
    461         $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
     536        $locale = get_locale();
     537        /**
     538         * Filter a plugin's locale.
     539         *
     540         * @since 3.0.0
     541         *
     542         * @param string $locale The plugin's current locale.
     543         * @param string $domain Text domain. Unique identifier for retrieving translated strings.
     544         */
     545        $locale = apply_filters( 'plugin_locale', $locale, $domain );
    462546
    463547        if ( false !== $plugin_rel_path ) {
    464548                $path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
     
    490574 * @return bool True when textdomain is successfully loaded, false otherwise.
    491575 */
    492576function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
     577        // duplicate_hook
    493578        $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
    494579        $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
    495580
     
    519604 * @return bool True when textdomain is successfully loaded, false otherwise.
    520605 */
    521606function load_theme_textdomain( $domain, $path = false ) {
    522         $locale = apply_filters( 'theme_locale', get_locale(), $domain );
     607        $locale = get_locale();
     608        /**
     609         * Filter a theme's locale.
     610         *
     611         * @since 3.0.0
     612         *
     613         * @param string $locale The theme's current locale.
     614         * @param string $domain Text domain. Unique identifier for retrieving translated strings.
     615         */
     616        $locale = apply_filters( 'theme_locale', $locale, $domain );
    523617
    524618        if ( ! $path )
    525619                $path = get_template_directory();