WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Locale_Switcher::change_locale()

WP_Locale_Switcher::change_locale( string $locale )

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Changes the site’s locale to the given one.

Description

Loads the translations, changes the global $wp_locale object and updates all post type labels.

Parameters

$localestringrequired
The locale to change to.

Source

private function change_locale( $locale ) {
	global $wp_locale;

	$this->load_translations( $locale );

	$wp_locale = new WP_Locale();

	WP_Translation_Controller::get_instance()->set_locale( $locale );

	/**
	 * Fires when the locale is switched to or restored.
	 *
	 * @since 4.7.0
	 *
	 * @param string $locale The new locale.
	 */
	do_action( 'change_locale', $locale );
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘change_locale’, string $locale )

Fires when the locale is switched to or restored.

UsesDescription
WP_Translation_Controller::get_instance()wp-includes/l10n/class-wp-translation-controller.php

Utility method to retrieve the main instance of the class.

WP_Locale_Switcher::load_translations()wp-includes/class-wp-locale-switcher.php

Load translations for a given locale.

WP_Locale::__construct()wp-includes/class-wp-locale.php

Constructor which calls helper methods to set up object variables.

do_action()wp-includes/plugin.php

Calls the callback functions that have been added to an action hook.

Show 1 moreShow less
Used byDescription
WP_Locale_Switcher::switch_to_locale()wp-includes/class-wp-locale-switcher.php

Switches the translations according to the given locale.

WP_Locale_Switcher::restore_previous_locale()wp-includes/class-wp-locale-switcher.php

Restores the translations according to the previous locale.

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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