WP_Locale_Switcher::switch_to_locale() WordPress Method
The WP_Locale_Switcher::switch_to_locale() method allows you to change the current language for the Wordpress site. This is useful if you need to display content in a different language or if you want to use Wordpress in a language other than the default.
WP_Locale_Switcher::switch_to_locale( string $locale ) #
Switches the translations according to the given locale.
Parameters
- $locale
(string)(Required)The locale to switch to.
Return
(bool) True on success, false on failure.
Source
File: wp-includes/class-wp-locale-switcher.php
public function switch_to_locale( $locale ) { $current_locale = determine_locale(); if ( $current_locale === $locale ) { return false; } if ( ! in_array( $locale, $this->available_languages, true ) ) { return false; } $this->locales[] = $locale; $this->change_locale( $locale ); /** * Fires when the locale is switched. * * @since 4.7.0 * * @param string $locale The new locale. */ do_action( 'switch_locale', $locale ); return true; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |