Changeset 38955

Timestamp:

10/26/2016 02:14:44 PM (8 years ago)

Author:

ocean90

Message:

I18N: Add $user_id argument to get_user_locale().

This allows to retrieve the locale of any user with the additional fallback to the site locale.

Fixes #38512.
See #29783, #26511.

Location:

trunk

Files:

• src/wp-includes/l10n.php (modified) (2 diffs)
• tests/phpunit/tests/l10n/getUserLocale.php (modified) (2 diffs)

trunk/src/wp-includes/l10n.php

@@ -77 +77 @@
 
 /**
- * Retrieves the locale of the current user.
+ * Retrieves the locale of a user.
  *
  * If the user has a locale set to a non-empty string then it will be
@@ -84 +84 @@
  * @since 4.7.0
  *
- * @return string The locale of the current user.
- */
-function get_user_locale() {
-    $user = wp_get_current_user();
+ * @param int|WP_User $user_id User's ID or a WP_User object. Defaults to current user.
+ * @return string The locale of the user.
+ */
+function get_user_locale( $user_id = 0 ) {
+    $user = false;
+    if ( 0 === $user_id ) {
+        $user = wp_get_current_user();
+    } elseif ( $user_id instanceof WP_User ) {
+        $user = $user_id;
+    } elseif ( is_numeric( $user_id ) ) {
+        $user = get_user_by( 'id', $user_id );
+    }
+
+    if ( ! $user ) {
+        return get_locale();
+    }
 
     $locale = $user->locale;
-    return ( '' === $locale ) ? get_locale() : $locale;
+    return $locale ? $locale : get_locale();
 }
 

trunk/tests/phpunit/tests/l10n/getUserLocale.php

@@ -44 +44 @@
     }
 
+    public function test_returns_site_locale_if_no_user() {
+        wp_set_current_user( 0 );
+        $this->assertSame( get_locale(), get_user_locale() );
+    }
+
     public function test_returns_correct_user_locale() {
         set_current_screen( 'dashboard' );
@@ -76 +81 @@
         $this->assertSame( $user_locale, $user_locale_2 );
     }
+
+    public function test_user_id_argument_with_id() {
+        $user_id = $this->factory()->user->create( array(
+            'locale' => 'es_ES',
+        ) );
+
+        $user_locale1 = get_user_locale( $user_id );
+
+        delete_user_meta( $user_id, 'locale' );
+
+        $user_locale2 = get_user_locale( $user_id );
+
+        $this->assertSame( 'es_ES', $user_locale1 );
+        $this->assertSame( get_locale(), $user_locale2 );
+    }
+
+    public function test_user_id_argument_with_wp_user_object() {
+        $user_id = $this->factory()->user->create( array(
+            'locale' => 'es_ES',
+        ) );
+
+        $user = get_user_by( 'id', $user_id );
+
+        $user_locale1 = get_user_locale( $user );
+
+        delete_user_meta( $user_id, 'locale' );
+
+        $user_locale2 = get_user_locale( $user );
+
+        $this->assertSame( 'es_ES', $user_locale1 );
+        $this->assertSame( get_locale(), $user_locale2 );
+    }
+
+    public function test_user_id_argument_with_nonexistent_user() {
+        global $wpdb;
+
+        $user_id = $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->users" ) + 1;
+
+        $user_locale = get_user_locale( $user_id );
+
+        $this->assertSame( get_locale(), $user_locale );
+    }
+
+    public function test_user_id_argument_with_invalid_type() {
+        $user_locale = get_user_locale( 'string' );
+        $this->assertSame( get_locale(), $user_locale );
+    }
 }