WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_user_locale()

get_user_locale( int|WP_User $user ): string

In this article

Back to top

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() .

Parameters

$userint|WP_Userrequired
User’s ID or a WP_User object. Defaults to current user.

Return

string The locale of the user.

Source

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();
}

View all references View on Trac View on GitHub

UsesDescription
get_locale()wp-includes/l10n.php

Retrieves the current locale.

wp_get_current_user()wp-includes/pluggable.php

Retrieves the current user object.

get_user_by()wp-includes/pluggable.php

Retrieves user info by a given field.

Used byDescription
WP_Locale_Switcher::switch_to_user_locale()wp-includes/class-wp-locale-switcher.php

Switches the translations according to the given user’s locale.

WP_REST_Pattern_Directory_Controller::get_items()wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

Search and retrieve block patterns metadata

WP_Debug_Data::debug_data()wp-admin/includes/class-wp-debug-data.php

Static function for generating site debug data when required.

determine_locale()wp-includes/l10n.php

Determines the current locale desired for the request.

wp_default_packages_vendor()wp-includes/script-loader.php

Registers all the WordPress vendor scripts that are in the standardized js/dist/vendor/ location.

wp_default_packages_inline_scripts()wp-includes/script-loader.php

Adds inline scripts required for the WordPress JavaScript packages.

_WP_Editors::get_mce_locale()wp-includes/class-wp-editor.php

Returns the TinyMCE locale.

WP_Community_Events::get_request_args()wp-admin/includes/class-wp-community-events.php

Builds an array of args to use in an HTTP request to the w.org Events API.

WP_REST_Users_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php

Prepares a single user output for response.

retrieve_password()wp-includes/user.php

Handles sending a password retrieval email to a user.

themes_api()wp-admin/includes/theme.php

Retrieves theme installer pages from the WordPress.org Themes API.

plugins_api()wp-admin/includes/plugin-install.php

Retrieves plugin installer pages from the WordPress.org Plugins API.

wp_dashboard_cached_rss_widget()wp-admin/includes/dashboard.php

Checks to see if all of the feed url in $check_urls are cached.

wp_dashboard_rss_control()wp-admin/includes/dashboard.php

Sets up the RSS dashboard widget control and $args to be used as input to wp_widget_rss_form() .

wp_dashboard_browser_nag()wp-admin/includes/dashboard.php

Displays the browser update nag.

WP_Plugin_Install_List_Table::prepare_items()wp-admin/includes/class-wp-plugin-install-list-table.php
iframe_header()wp-admin/includes/template.php

Generic Iframe header for use with Thickbox.

wp_get_popular_importers()wp-admin/includes/import.php

Returns a list from WordPress.org of popular importer plugins.

wp_credits()wp-admin/includes/credits.php

Retrieves the contributor credits.

WP_Theme::sort_by_name()wp-includes/class-wp-theme.php

Sorts themes by name.

wp_auth_check_html()wp-includes/functions.php

Outputs the HTML that shows the wp-login dialog when the user is no longer logged in.

_WP_Editors::editor_settings()wp-includes/class-wp-editor.php
Show 17 moreShow less

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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