get_locale(): string

Description

Return

string

The locale of the blog or from the 'locale' hook.

Hooks fired · 2

2 hooks fire while get_locale() runs, in this order:

1. 1
   apply_filters( locale )filterline 35 (+5 into the body)

   Filters the locale ID of the WordPress installation.

2. 2
   apply_filters( locale )filterline 80 (+50 into the body)

   Filters the locale ID of the WordPress installation.

Uses · 5

• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_multisite()Determines whether Multisite is enabled.
• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• get_site_option()Retrieve an option value for the current network based on name of option.
• get_option()Retrieves an option value based on an option name.

Used by · 27

• WP_Automatic_Updater::send_debug_email()Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
• WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
• WP_Automatic_Updater::send_plugin_theme_email()Sends an email upon the completion or failure of a plugin or theme background update.
• WP_Debug_Data::get_wp_core()Gets the WordPress core section of the debug data.
• WP_Recovery_Mode_Email_Service::send_recovery_mode_email()Sends the Recovery Mode email to the site admin email address.
• _wp_privacy_send_erasure_fulfillment_notification()Notifies the user when their erasure request is fulfilled.
• determine_locale()Determines the current locale desired for the request.
• get_locale_stylesheet_uri()Retrieves the localized stylesheet URI.
• get_user_locale()Retrieves the locale of a user.
• insert_with_markers()Inserts an array of strings into a file (.htaccess), placing it between BEGIN and END markers.
• list_core_update()Lists available core updates.
• list_translation_updates()Display the update translations form.

Source

View on Trac ↗View on GitHub ↗

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

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/l10n.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.