WP_Locale_Switcher::switch_to_locale │ public │ WP 4.7.0

Switches the translations according to the given locale.

Method of the class: WP_Locale_Switcher{}

Returns

true|false. True on success, false on failure.

Usage

$WP_Locale_Switcher = new WP_Locale_Switcher();
$WP_Locale_Switcher->switch_to_locale( $locale, $user_id );

$locale(string) (required)

The locale to switch to.

$user_id(int|false)

User ID as context.
Default: false

Changelog

WP_Locale_Switcher::switch_to_locale() WP Locale Switcher::switch to locale code ^{WP 6.9}

public function switch_to_locale( $locale, $user_id = false ) {
	$current_locale = determine_locale();
	if ( $current_locale === $locale ) {
		return false;
	}

	if ( ! in_array( $locale, $this->available_languages, true ) ) {
		return false;
	}

	$this->stack[] = array( $locale, $user_id );

	$this->change_locale( $locale );

	/**
	 * Fires when the locale is switched.
	 *
	 * @since 4.7.0
	 * @since 6.2.0 The `$user_id` parameter was added.
	 *
	 * @param string    $locale  The new locale.
	 * @param false|int $user_id User ID for context if available.
	 */
	do_action( 'switch_locale', $locale, $user_id );

	return true;
}