WP_Locale_Switcher::switch_to_locale( string $locale ): bool

Switches the translations according to the given locale.


Parameters

$locale string Required
The locale to switch to.

Top ↑

Return

bool True on success, false on failure.


Top ↑

Source

File: wp-includes/class-wp-locale-switcher.php. View all references

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

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
4.7.0 Introduced.

Top ↑

User Contributed Notes

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