Changeset 55224

Timestamp:

02/04/2023 08:45:36 PM (20 months ago)

Author:

swissspidy

Message:

I18N: Improve method names in WP_Locale_Switcher().

This is a follow-up to [55161] to rename ::get_current_locale() to ::get_switched_locale() and ::get_current_user_id() to ::get_switched_user_id() for improved clarity.

Also:

• Fix docblock for switch_locale filter. The User ID is false if missing, not null.
• Add additional test involving restore_previous_locale() and improve test cleanup.

And most importantly: happy birthday ocean90! 🎂

Props johnjamesjacoby, ocean90.
See #57123.

Location:

trunk

Files:

• src/wp-includes/class-wp-locale-switcher.php (modified) (4 diffs)
• tests/phpunit/tests/l10n/wpLocaleSwitcher.php (modified) (4 diffs)

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

@@ -93 +93 @@
          * @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.
+         * @param string    $locale  The new locale.
+         * @param false|int $user_id User ID for context if available.
          */
         do_action( 'switch_locale', $locale, $user_id );
@@ -187 +187 @@
      * @return string|false Locale if the locale has been switched, false otherwise.
      */
-    public function get_current_locale() {
+    public function get_switched_locale() {
         $entry = end( $this->stack );
 
@@ -204 +204 @@
      * @return int|false User ID if set and if the locale has been switched, false otherwise.
      */
-    public function get_current_user_id() {
+    public function get_switched_user_id() {
         $entry = end( $this->stack );
 
@@ -223 +223 @@
      */
     public function filter_locale( $locale ) {
-        $switched_locale = $this->get_current_locale();
+        $switched_locale = $this->get_switched_locale();
 
         if ( $switched_locale ) {

trunk/tests/phpunit/tests/l10n/wpLocaleSwitcher.php

@@ -55 +55 @@
         $wp_textdomain_registry = new WP_Textdomain_Registry();
 
+        // Clean up after any tests that don't restore the locale afterwards,
+        // before resetting $wp_locale_switcher.
+        restore_current_locale();
+
         remove_filter( 'locale', array( $wp_locale_switcher, 'filter_locale' ) );
         $wp_locale_switcher = new WP_Locale_Switcher();
@@ -599 +603 @@
      * @covers ::switch_to_locale
      * @covers ::switch_to_user_locale
-     * @covers WP_Locale_Switcher::get_current_locale
-     * @covers WP_Locale_Switcher::get_current_user_id
+     * @covers WP_Locale_Switcher::get_switched_locale
+     * @covers WP_Locale_Switcher::get_switched_user_id
      */
     public function test_returns_current_locale_and_user_after_switching() {
@@ -612 +616 @@
         );
 
-        $locale_1  = $wp_locale_switcher->get_current_locale();
-        $user_id_1 = $wp_locale_switcher->get_current_user_id();
+        $locale_1  = $wp_locale_switcher->get_switched_locale();
+        $user_id_1 = $wp_locale_switcher->get_switched_user_id();
 
         switch_to_user_locale( self::$user_id );
 
-        $locale_2  = $wp_locale_switcher->get_current_locale();
-        $user_id_2 = $wp_locale_switcher->get_current_user_id();
-
-        switch_to_locale( 'en_GB' );
-
-        $locale_3  = $wp_locale_switcher->get_current_locale();
-        $user_id_3 = $wp_locale_switcher->get_current_user_id();
+        $locale_2  = $wp_locale_switcher->get_switched_locale();
+        $user_id_2 = $wp_locale_switcher->get_switched_user_id();
+
+        switch_to_locale( 'en_GB' );
+
+        $locale_3  = $wp_locale_switcher->get_switched_locale();
+        $user_id_3 = $wp_locale_switcher->get_switched_user_id();
 
         switch_to_user_locale( $user_2 );
 
-        $locale_4  = $wp_locale_switcher->get_current_locale();
-        $user_id_4 = $wp_locale_switcher->get_current_user_id();
-
-        restore_current_locale();
-
-        $locale_5  = $wp_locale_switcher->get_current_locale();
-        $user_id_5 = $wp_locale_switcher->get_current_user_id();
+        $locale_4  = $wp_locale_switcher->get_switched_locale();
+        $user_id_4 = $wp_locale_switcher->get_switched_user_id();
+
+        restore_current_locale();
+
+        $locale_5  = $wp_locale_switcher->get_switched_locale();
+        $user_id_5 = $wp_locale_switcher->get_switched_user_id();
 
         $this->assertFalse( $locale_1, 'Locale should be false before switching' );
@@ -649 +653 @@
         $this->assertFalse( $locale_5, 'Locale should be false after restoring' );
         $this->assertFalse( $user_id_5, 'User ID should be false after restoring' );
-
+    }
+
+    /**
+     * @ticket 57123
+     *
+     * @covers ::switch_to_locale
+     * @covers ::switch_to_user_locale
+     * @covers WP_Locale_Switcher::get_switched_locale
+     * @covers WP_Locale_Switcher::get_switched_user_id
+     */
+    public function test_returns_previous_locale_and_user_after_switching() {
+        global $wp_locale_switcher;
+
+        $locale_1  = $wp_locale_switcher->get_switched_locale();
+        $user_id_1 = $wp_locale_switcher->get_switched_user_id();
+
+        switch_to_user_locale( self::$user_id );
+
+        $locale_2  = $wp_locale_switcher->get_switched_locale();
+        $user_id_2 = $wp_locale_switcher->get_switched_user_id();
+
+        switch_to_locale( 'en_GB' );
+
+        $locale_3  = $wp_locale_switcher->get_switched_locale();
+        $user_id_3 = $wp_locale_switcher->get_switched_user_id();
+
+        restore_previous_locale();
+
+        $locale_4  = $wp_locale_switcher->get_switched_locale();
+        $user_id_4 = $wp_locale_switcher->get_switched_user_id();
+
+        $this->assertFalse( $locale_1, 'Locale should be false before switching' );
+        $this->assertFalse( $user_id_1, 'User ID should be false before switching' );
+
+        $this->assertSame( 'de_DE', $locale_2, 'The locale was not changed to de_DE' );
+        $this->assertSame( self::$user_id, $user_id_2, 'User ID should match the main admin ID' );
+
+        $this->assertSame( 'en_GB', $locale_3, 'The locale was not changed to en_GB' );
+        $this->assertFalse( $user_id_3, 'User ID should be false after normal locale switching' );
+
+        $this->assertSame( 'de_DE', $locale_4, 'The locale was not changed back to de_DE' );
+        $this->assertSame( self::$user_id, $user_id_4, 'User ID should match the main admin ID again' );
     }