Changeset 55161 for trunk/src/wp-includes/l10n.php

Timestamp:

01/30/2023 10:25:53 AM (23 months ago)

Author:

swissspidy

Message:

I18N: Introduce switch_to_user_locale().

This new function makes it easier to switch to a specific user’s locale by reducing duplicate code and storing the user’s ID as additional context for plugins to consume. Existing usage of switch_to_locale() in core has been replaced with switch_to_user_locale() where appropriate.

Also, this change ensures WP_Locale_Switcher properly filters determine_locale so that anyyone using the determine_locale() function will get the correct locale information when switching is in effect.

Props costdev.
Fixes #57123.
See #26511.

File:

• trunk/src/wp-includes/l10n.php (modified) (3 diffs)

trunk/src/wp-includes/l10n.php

@@ -1666 +1666 @@
     global $wp_locale_switcher;
 
+    if ( ! $wp_locale_switcher ) {
+        return false;
+    }
+
     return $wp_locale_switcher->switch_to_locale( $locale );
+}
+
+/**
+ * Switches the translations according to the given user's locale.
+ *
+ * @since 6.2.0
+ *
+ * @global WP_Locale_Switcher $wp_locale_switcher WordPress locale switcher object.
+ *
+ * @param int $user_id User ID.
+ * @return bool True on success, false on failure.
+ */
+function switch_to_user_locale( $user_id ) {
+    /* @var WP_Locale_Switcher $wp_locale_switcher */
+    global $wp_locale_switcher;
+
+    if ( ! $wp_locale_switcher ) {
+        return false;
+    }
+
+    return $wp_locale_switcher->switch_to_user_locale( $user_id );
 }
 
@@ -1682 +1707 @@
     global $wp_locale_switcher;
 
+    if ( ! $wp_locale_switcher ) {
+        return false;
+    }
+
     return $wp_locale_switcher->restore_previous_locale();
 }
@@ -1697 +1726 @@
     /* @var WP_Locale_Switcher $wp_locale_switcher */
     global $wp_locale_switcher;
+
+    if ( ! $wp_locale_switcher ) {
+        return false;
+    }
 
     return $wp_locale_switcher->restore_current_locale();