get_user_locale( int|WP_User $user ): string

Retrieves the locale of a user.


Description

If the user has a locale set to a non-empty string then it will be returned. Otherwise it returns the locale of get_locale() .


Top ↑

Parameters

$user int|WP_User Required
User's ID or a WP_User object. Defaults to current user.

Top ↑

Return

string The locale of the user.


Top ↑

Source

File: wp-includes/l10n.php. View all references

function get_user_locale( $user = 0 ) {
	$user_object = false;

	if ( 0 === $user && function_exists( 'wp_get_current_user' ) ) {
		$user_object = wp_get_current_user();
	} elseif ( $user instanceof WP_User ) {
		$user_object = $user;
	} elseif ( $user && is_numeric( $user ) ) {
		$user_object = get_user_by( 'id', $user );
	}

	if ( ! $user_object ) {
		return get_locale();
	}

	$locale = $user_object->locale;

	return $locale ? $locale : get_locale();
}


Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

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