WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

switch_to_locale()

switch_to_locale( string $locale ): bool

In this article

Back to top

Switches the translations according to the given locale.

Parameters

$localestringrequired
The locale.

Return

bool True on success, false on failure.

Source

function switch_to_locale( $locale ) {
	/* @var WP_Locale_Switcher $wp_locale_switcher */
	global $wp_locale_switcher;

	if ( ! $wp_locale_switcher ) {
		return false;
	}

	return $wp_locale_switcher->switch_to_locale( $locale );
}

View all references View on Trac View on GitHub

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

Switches the translations according to the given locale.

Used byDescription
wpmu_new_site_admin_notification()wp-includes/ms-functions.php

Notifies the Multisite network administrator that a new site was created.

WP_Recovery_Mode_Email_Service::send_recovery_mode_email()wp-includes/class-wp-recovery-mode-email-service.php

Sends the Recovery Mode email to the site admin email address.

_wp_privacy_send_erasure_fulfillment_notification()wp-includes/user.php

Notifies the user when their erasure request is fulfilled.

wp_send_user_request()wp-includes/user.php

Send a confirmation request email to confirm an action.

wp_privacy_send_personal_data_export_email()wp-admin/includes/privacy-tools.php

Send an email to the user with a link to the personal data export file

insert_with_markers()wp-admin/includes/misc.php

Inserts an array of strings into a file (.htaccess), placing it between BEGIN and END markers.

wp_new_user_notification()wp-includes/pluggable.php

Emails login credentials to a newly-registered user.

wp_notify_postauthor()wp-includes/pluggable.php

Notifies an author (and/or others) of a comment/trackback/pingback on a post.

wp_notify_moderator()wp-includes/pluggable.php

Notifies the moderator of the site about a new comment that is awaiting approval.

Show 4 moreShow less

Changelog

VersionDescription
4.7.0Introduced.

User Contributed Notes

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