switch_to_user_locale( int $user_id ): bool

Parameters

$user_idint

User ID.

Return

bool

True on success, false on failure.

Used by · 19

• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Selective_Refresh::export_preview_data()Exports data in preview after it has finished rendering so that partials can be added at runtime.
• WP_Customize_Widgets::export_preview_data()Communicates the sidebars that appeared on the page at the very end of the page, and at the very end of the wp_footer,
• _wp_privacy_send_erasure_fulfillment_notification()Notifies the user when their erasure request is fulfilled.
• retrieve_password()Handles sending a password retrieval email to a user.
• update_network_option_new_admin_email()Sends a confirmation request email when a change of network admin email address is attempted.
• update_option_new_admin_email()Sends a confirmation request email when a change of site admin email address is attempted.
• 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

Source

View on Trac ↗View on GitHub ↗

1845function switch_to_user_locale( $user_id ) {1846	/* @var WP_Locale_Switcher $wp_locale_switcher */1847	global $wp_locale_switcher;1848 1849	if ( ! $wp_locale_switcher ) {1850		return false;1851	}1852 1853	return $wp_locale_switcher->switch_to_user_locale( $user_id );1854}

History

Introduced in 6.2.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.7.7 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.