WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

switch_to_locale()

switch_to_locale( string $locale ): bool

In this article

Back to top

Switches the translations according to the given locale.

Parameters

$localestringrequired
The locale.

Return

bool True on success, false on failure.

Source

 * @since 4.7.0
 *
 * @global WP_Locale_Switcher $wp_locale_switcher WordPress locale switcher object.
 *
 * @param string $locale The locale.
 * @return bool True on success, false on failure.
 */
function switch_to_locale( $locale ) {
	/* @var WP_Locale_Switcher $wp_locale_switcher */
	global $wp_locale_switcher;

View all references View on Trac View on GitHub

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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