Changeset 55161 for trunk/src/wp-includes/class-wp-locale-switcher.php

Timestamp:

01/30/2023 10:25:53 AM (22 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/class-wp-locale-switcher.php (modified) (13 diffs)

trunk/src/wp-includes/class-wp-locale-switcher.php

@@ -16 +16 @@
 class WP_Locale_Switcher {
     /**
-     * Locale stack.
-     *
-     * @since 4.7.0
-     * @var string[]
-     */
-    private $locales = array();
+     * Locale switching stack.
+     *
+     * @since 4.7.0
+     * @var array
+     */
+    private $stack = array();
 
     /**
@@ -54 +54 @@
      * Initializes the locale switcher.
      *
-     * Hooks into the {@see 'locale'} filter to change the locale on the fly.
+     * Hooks into the {@see 'locale'} and {@see 'determine_locale'} filters
+     * to change the locale on the fly.
      *
      * @since 4.7.0
@@ -60 +61 @@
     public function init() {
         add_filter( 'locale', array( $this, 'filter_locale' ) );
+        add_filter( 'determine_locale', array( $this, 'filter_locale' ) );
     }
 
@@ -67 +69 @@
      * @since 4.7.0
      *
-     * @param string $locale The locale to switch to.
+     * @param string    $locale  The locale to switch to.
+     * @param int|false $user_id Optional. User ID as context. Default false.
      * @return bool True on success, false on failure.
      */
-    public function switch_to_locale( $locale ) {
+    public function switch_to_locale( $locale, $user_id = false ) {
         $current_locale = determine_locale();
         if ( $current_locale === $locale ) {
@@ -80 +83 @@
         }
 
-        $this->locales[] = $locale;
+        $this->stack[] = array( $locale, $user_id );
 
         $this->change_locale( $locale );
@@ -88 +91 @@
          *
          * @since 4.7.0
-         *
-         * @param string $locale The new locale.
+         * @since 6.2.0 The `$user_id` parameter was added.
+         *
+         * @param string   $locale  The new locale.
+         * @param null|int $user_id User ID for context if available.
          */
-        do_action( 'switch_locale', $locale );
+        do_action( 'switch_locale', $locale, $user_id );
 
         return true;
@@ -97 +102 @@
 
     /**
+     * Switches the translations according to the given user's locale.
+     *
+     * @since 6.2.0
+     *
+     * @param int $user_id User ID.
+     * @return bool True on success, false on failure.
+     */
+    public function switch_to_user_locale( $user_id ) {
+        $locale = get_user_locale( $user_id );
+        return $this->switch_to_locale( $locale, $user_id );
+    }
+
+    /**
      * Restores the translations according to the previous locale.
      *
@@ -104 +122 @@
      */
     public function restore_previous_locale() {
-        $previous_locale = array_pop( $this->locales );
+        $previous_locale = array_pop( $this->stack );
 
         if ( null === $previous_locale ) {
@@ -111 +129 @@
         }
 
-        $locale = end( $this->locales );
+        $entry  = end( $this->stack );
+        $locale = is_array( $entry ) ? $entry[0] : false;
 
         if ( ! $locale ) {
@@ -128 +147 @@
          * @param string $previous_locale The previous locale.
          */
-        do_action( 'restore_previous_locale', $locale, $previous_locale );
+        do_action( 'restore_previous_locale', $locale, $previous_locale[0] );
 
         return $locale;
@@ -141 +160 @@
      */
     public function restore_current_locale() {
-        if ( empty( $this->locales ) ) {
-            return false;
-        }
-
-        $this->locales = array( $this->original_locale );
+        if ( empty( $this->stack ) ) {
+            return false;
+        }
+
+        $this->stack = array( array( $this->original_locale, false ) );
 
         return $this->restore_previous_locale();
@@ -158 +177 @@
      */
     public function is_switched() {
-        return ! empty( $this->locales );
+        return ! empty( $this->stack );
+    }
+
+    /**
+     * Returns the locale currently switched to.
+     *
+     * @since 6.2.0
+     *
+     * @return string|false Locale if the locale has been switched, false otherwise.
+     */
+    public function get_current_locale() {
+        $entry = end( $this->stack );
+
+        if ( $entry ) {
+            return $entry[0];
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns the user ID related to the currently switched locale.
+     *
+     * @since 6.2.0
+     *
+     * @return int|false User ID if set and if the locale has been switched, false otherwise.
+     */
+    public function get_current_user_id() {
+        $entry = end( $this->stack );
+
+        if ( $entry ) {
+            return $entry[1];
+        }
+
+        return false;
     }
 
@@ -170 +223 @@
      */
     public function filter_locale( $locale ) {
-        $switched_locale = end( $this->locales );
+        $switched_locale = $this->get_current_locale();
 
         if ( $switched_locale ) {