Changeset 53702

Timestamp:

07/15/2022 01:43:51 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename the $user_id parameter of get_user_locale() to $user for accuracy.

Since the parameter accepts not only a user's ID, but also a WP_User object, $user is a more appropriate name, which better aligns with the $post parameter of functions that accept a post ID or a WP_Post object.

The pre-existing internal $user variable which contained a WP_User object is renamed to $user_object for clarity.

Follow-up to [38955].

Props aristath, poena, afercia, SergeyBiryukov.
See #55647.

File:

• trunk/src/wp-includes/l10n.php (modified) (1 diff)

trunk/src/wp-includes/l10n.php

@@ -89 +89 @@
  * @since 4.7.0
  *
- * @param int|WP_User $user_id User's ID or a WP_User object. Defaults to current user.
+ * @param int|WP_User $user 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 && function_exists( 'wp_get_current_user' ) ) {
-        $user = wp_get_current_user();
-    } elseif ( $user_id instanceof WP_User ) {
-        $user = $user_id;
-    } elseif ( $user_id && is_numeric( $user_id ) ) {
-        $user = get_user_by( 'id', $user_id );
-    }
-
-    if ( ! $user ) {
+function get_user_locale( $user = 0 ) {
+    $user_object = false;
+
+    if ( 0 === $user && function_exists( 'wp_get_current_user' ) ) {
+        $user_object = wp_get_current_user();
+    } elseif ( $user instanceof WP_User ) {
+        $user_object = $user;
+    } elseif ( $user && is_numeric( $user ) ) {
+        $user_object = get_user_by( 'id', $user );
+    }
+
+    if ( ! $user_object ) {
         return get_locale();
     }
 
-    $locale = $user->locale;
+    $locale = $user_object->locale;
+
     return $locale ? $locale : get_locale();
 }