get_locale()

Retrieves the current locale.

Contents

Description Description

If the locale is set, then it will filter the locale in the ‘locale’ filter hook and return the value.

If the locale is not set already, then the WPLANG constant is used if it is defined. Then it is filtered through the ‘locale’ filter hook and the value for the locale global set and the locale is returned.

The process to get the locale should only be done once, but the locale will always be filtered using the ‘locale’ hook.

Return Return

(string) The locale of the blog or from the 'locale' hook.

Top ↑

Source Source

File: wp-includes/l10n.php

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
function get_locale() {
    global $locale, $wp_local_package;
 
    if ( isset( $locale ) ) {
        /**
         * Filters the locale ID of the WordPress installation.
         *
         * @since 1.5.0
         *
         * @param string $locale The locale ID.
         */
        return apply_filters( 'locale', $locale );
    }
 
    if ( isset( $wp_local_package ) ) {
        $locale = $wp_local_package;
    }
 
    // WPLANG was defined in wp-config.
    if ( defined( 'WPLANG' ) ) {
        $locale = WPLANG;
    }
 
    // If multisite, check options.
    if ( is_multisite() ) {
        // Don't check blog option when installing.
        if ( wp_installing() || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
            $ms_locale = get_site_option( 'WPLANG' );
        }
 
        if ( $ms_locale !== false ) {
            $locale = $ms_locale;
        }
    } else {
        $db_locale = get_option( 'WPLANG' );
        if ( $db_locale !== false ) {
            $locale = $db_locale;
        }
    }
 
    if ( empty( $locale ) ) {
        $locale = 'en_US';
    }
 
    /** This filter is documented in wp-includes/l10n.php */
    return apply_filters( 'locale', $locale );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/load.php: wp_installing()

Check or set whether WordPress is in “installation” mode.
wp-includes/l10n.php: locale

Filters the locale ID of the WordPress installation.
wp-includes/load.php: is_multisite()

If Multisite is enabled.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/option.php: get_site_option()

Retrieve an option value for the current network based on name of option.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
Show 1 more use Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/schema.php: populate_network_meta()

Creates WordPress network meta and sets the default values.
wp-includes/l10n.php: determine_locale()

Determine the current locale desired for the request.
wp-includes/user.php: wp_send_user_request()

Send a confirmation request email to confirm an action.
wp-includes/l10n.php: get_user_locale()

Retrieves the locale of a user.
wp-includes/functions.php: wp_maybe_decline_date()

Determines if the date should be declined.
wp-admin/includes/translation-install.php: translations_api()

Retrieve translations from WordPress Translation API.
wp-login.php: login_header()

Output the login page header.
wp-admin/update-core.php: list_core_update()
wp-admin/update-core.php: list_translation_updates()
wp-includes/theme.php: get_locale_stylesheet_uri()

Retrieves the localized stylesheet URI.
wp-includes/formatting.php: remove_accents()

Converts all accent characters to ASCII characters.
wp-includes/pluggable.php: wp_new_user_notification()

Email login credentials to a newly-registered user.
wp-includes/pluggable.php: wp_notify_postauthor()

Notify an author (and/or others) of a comment/trackback/pingback on a post.
wp-includes/pluggable.php: wp_notify_moderator()

Notifies the moderator of the site about a new comment that is awaiting approval.
wp-includes/functions.php: wp_timezone_choice()

Gives a nicely-formatted list of timezone strings.
wp-includes/update.php: wp_version_check()

Check WordPress version against the newest version.
Show 11 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.