Changeset 35790 for trunk/src/wp-includes/user.php

Timestamp:

12/06/2015 08:56:11 PM (9 years ago)

Author:

boonebgorges

Message:

Show user_login in Dashboard user dropdowns.

User dropdowns in wp-admin have traditionally shown the users' display names.
However, this causes ambiguity when users share display names. To correct this,
we now show the unique user_login in parentheses after the display name.

The new display_name_with_login value for the show parameter of
wp_dropdown_users() enables this functionality. The default value of show
has not been changed, for backward compatibility, but all instances of
wp_dropdown_users() in core wp-admin have been switched.

This changeset also reduces some duplicated logic when assembling a user list
when include_selected is true.

Props krogsgard, boonebgorges.
Fixes #31251.

File:

• trunk/src/wp-includes/user.php (modified) (4 diffs)

trunk/src/wp-includes/user.php

@@ -871 +871 @@
  *
  * @since 2.3.0
+ * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
  *
  * @global int  $blog_id
@@ -897 +898 @@
  *     @type bool|int     $multi                   Whether to skip the ID attribute on the 'select' element.
  *                                                 Accepts 1|true or 0|false. Default 0|false.
- *     @type string       $show                    User table column to display. If the selected item is empty
+ *     @type string       $show                    User data to display. If the selected item is empty
  *                                                 then the 'user_login' will be displayed in parentheses.
- *                                                 Accepts user fields. Default 'display_name'.
+ *                                                 Accepts any user field, or 'display_name_with_login' to show
+ *                                                 the display name with user_login in parentheses.
+ *                                                 Default 'display_name'.
  *     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
  *                                                 or 0|false (return). Default 1|true.
@@ -928 +931 @@
 
     $r = wp_parse_args( $args, $defaults );
-    $show = $r['show'];
+
+    $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
+
+    $fields = array( 'ID', 'user_login' );
+
+    $show = ! empty( $r['show'] ) ? $r['show'] : 'display_name';
+    if ( 'display_name_with_login' === $show ) {
+        $fields[] = 'display_name';
+    } else {
+        $fields[] = $show;
+    }
+
+    $query_args['fields'] = $fields;
+
     $show_option_all = $r['show_option_all'];
     $show_option_none = $r['show_option_none'];
     $option_none_value = $r['option_none_value'];
-
-    $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
-    $query_args['fields'] = array( 'ID', 'user_login', $show );
 
     /**
@@ -967 +980 @@
         }
 
-        $found_selected = false;
+        if ( $r['include_selected'] && ( $r['selected'] > 0 ) ) {
+            $found_selected = false;
+            $r['selected'] = (int) $r['selected'];
+            foreach ( (array) $users as $user ) {
+                $user->ID = (int) $user->ID;
+                if ( $user->ID === $r['selected'] ) {
+                    $found_selected = true;
+                }
+            }
+
+            if ( ! $found_selected ) {
+                $users[] = get_userdata( $r['selected'] );
+            }
+        }
+
         foreach ( (array) $users as $user ) {
-            $user->ID = (int) $user->ID;
+            if ( 'display_name_with_login' === $show ) {
+                /* translators: 1: display name, 2: user_login */
+                $display = sprintf( _x( '%1$s (%2$s)', 'user dropdown' ), $user->display_name, $user->user_login );
+            } elseif ( ! empty( $user->$show ) ) {
+                $display = $user->$show;
+            } else {
+                $display = '(' . $user->user_login . ')';
+            }
+
             $_selected = selected( $user->ID, $r['selected'], false );
-            if ( $_selected ) {
-                $found_selected = true;
-            }
-            $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
-            $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
-        }
-
-        if ( $r['include_selected'] && ! $found_selected && ( $r['selected'] > 0 ) ) {
-            $user = get_userdata( $r['selected'] );
-            $_selected = selected( $user->ID, $r['selected'], false );
-            $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
             $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
         }