WP_Locale_Switcher::change_locale( string $locale )

Description

Parameters

$localestring

The locale to change to.

Hooks fired · 1

One hook fires while WP_Locale_Switcher::change_locale() runs, in this order:

1. 1
   do_action( change_locale )actionline 295 (+16 into the body)

   Fires when the locale is switched to or restored.

Uses · 5

• do_action()Calls the callback functions that have been added to an action hook.
• WP_Locale_Switcher::load_translations()Load translations for a given locale.
• WP_Locale::__construct()Constructor which calls helper methods to set up object variables.
• WP_Translation_Controller::get_instance()::set_locale()
• WP_Translation_Controller::get_instance()Utility method to retrieve the main instance of the class.

Used by · 2

• WP_Locale_Switcher::restore_previous_locale()Restores the translations according to the previous locale.
• WP_Locale_Switcher::switch_to_locale()Switches the translations according to the given locale.

Source

View on Trac ↗View on GitHub ↗

279	private function change_locale( $locale ) {280		global $wp_locale;281 282		$this->load_translations( $locale );283 284		$wp_locale = new WP_Locale();285 286		WP_Translation_Controller::get_instance()->set_locale( $locale );287 288		/**289		 * Fires when the locale is switched to or restored.290		 *291		 * @since 4.7.0292		 *293		 * @param string $locale The new locale.294		 */295		do_action( 'change_locale', $locale );296	}

History

Introduced in 4.7.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 6.7.7 tag, from src/wp-includes/class-wp-locale-switcher.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.