switch_to_locale( string $locale ): bool

Parameters

$localestring

The locale.

Return

bool

True on success, false on failure.

Used by · 13

• WP_Automatic_Updater::send_debug_email()Prepares and sends an email of a full log of background update results, useful for debugging and geekery.
• WP_Automatic_Updater::send_email()Sends an email upon the completion or failure of a background core update.
• WP_Automatic_Updater::send_plugin_theme_email()Sends an email upon the completion or failure of a plugin or theme background update.
• WP_Recovery_Mode_Email_Service::send_recovery_mode_email()Sends the Recovery Mode email to the site admin email address.
• _wp_privacy_send_erasure_fulfillment_notification()Notifies the user when their erasure request is fulfilled.
• insert_with_markers()Inserts an array of strings into a file (.htaccess), placing it between BEGIN and END markers.
• wp_new_user_notification()Emails login credentials to a newly-registered user.
• wp_notify_moderator()Notifies the moderator of the site about a new comment that is awaiting approval.
• wp_notify_postauthor()Notifies an author (and/or others) of a comment/trackback/pingback on a post.
• wp_password_change_notification()Notifies the blog admin of a user changing password, normally via email.
• wp_privacy_send_personal_data_export_email()Send an email to the user with a link to the personal data export file
• wp_send_user_request()Send a confirmation request email to confirm an action.

Source

View on Trac ↗View on GitHub ↗

1825function switch_to_locale( $locale ) {1826	/* @var WP_Locale_Switcher $wp_locale_switcher */1827	global $wp_locale_switcher;1828 1829	if ( ! $wp_locale_switcher ) {1830		return false;1831	}1832 1833	return $wp_locale_switcher->switch_to_locale( $locale );1834}

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.8.8 tag, from src/wp-includes/l10n.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.