Ticket #31251: 31251.patch

src/wp-includes/user.php

@@ -1355 +1355 @@
  * The available arguments are as follows:
  *
  * @since 2.3.0
+ * @since 4.2.0 The default value for $show was changed to empty
  *
  * @global wpdb $wpdb WordPress database object for queries.
  *
@@ -1382 +1383 @@
  *     @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
- *                                                 then the 'user_login' will be displayed in parentheses.
- *                                                 Accepts user fields. Default 'display_name'.
+ *                                                 then the 'display_name' will be displayed with the 'user_login' in parenthesis.
+ *                                                 Accepts user fields. Default 'display_name' with 'user_login' in parenthesis.
  *     @type int|bool     $echo                    Whether to echo or return the drop-down. Accepts 1|true (echo)
  *                                                 or 0|false (return). Default 1|true.
  *     @type int          $selected                Which user ID should be selected. Default 0.
@@ -1403 +1404 @@
                 'show_option_all' => '', 'show_option_none' => '', 'hide_if_only_one_author' => '',
                 'orderby' => 'display_name', 'order' => 'ASC',
                 'include' => '', 'exclude' => '', 'multi' => 0,
-                'show' => 'display_name', 'echo' => 1,
+                'show' => '', 'echo' => 1,
                 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
                 'blog_id' => $GLOBALS['blog_id'], 'who' => '', 'include_selected' => false,
                 'option_none_value' => -1
@@ -1418 +1419 @@
         $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 );
+        $query_args['fields'] = array( 'ID', 'user_login', 'display_name' );
         $users = get_users( $query_args );
 
         $output = '';
@@ -1447 +1448 @@
                         if ( $_selected ) {
                                 $found_selected = true;
                         }
-                        $display = ! empty( $user->$show ) ? $user->$show : '('. $user->user_login . ')';
+                        $display = ! empty( $user->$show ) ? $user->$show : $user->display_name . ' ('. $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 . ')';
+                        $display = ! empty( $user->$show ) ? $user->$show : $user->display_name . ' ('. $user->user_login . ')';
                         $output .= "\t<option value='$user->ID'$_selected>" . esc_html( $display ) . "</option>\n";
                 }
 

tests/phpunit/tests/user/wpDropdownUsers.php

@@ +1 @@
+<?php
+
+/**
+ * Test functions in wp-includes/user.php
+ *
+ * @group user
+ */
+class Tests_User_WpDropdownUsers extends WP_UnitTestCase {
+
+        /**
+         * @ticket 31251
+         */
+        public function test_show_should_display_display_name_and_user_in_parenthesis_when_show_is_not_specified() {
+
+                // create a user with a different display_name
+                $u = $this->factory->user->create( array(
+                        'user_login'   => 'foo',
+                        'display_name' => 'Foo Person'
+                ) );
+
+                // Get the result of a non-default, but acceptable input for 'show' parameter to wp_dropdown_users().
+                $found = wp_dropdown_users( array(
+                        'echo' => false
+                ) );
+
+                $expected = "<option value='$u'>Foo Person (foo)</option>";
+
+                $this->assertContains( $expected, $found );
+        }
+
+        /**
+         * @ticket 31251
+         */
+        public function test_show_should_display_display_name_and_user_in_parenthesis_when_show_is_specified_as_empty() {
+
+                // create a user with a different display_name
+                $u = $this->factory->user->create( array(
+                        'user_login'   => 'foo',
+                        'display_name' => 'Foo Person'
+                ) );
+
+                // Get the result of a non-default, but acceptable input for 'show' parameter to wp_dropdown_users().
+                $found = wp_dropdown_users( array(
+                        'echo' => false,
+                        'show' => ''
+                ) );
+
+                $expected = "<option value='$u'>Foo Person (foo)</option>";
+
+                $this->assertContains( $expected, $found );
+        }
+
+        /**
+         * @ticket 31251
+         */
+        public function test_show_should_display_user_property_when_the_value_of_show_is_a_valid_user_property() {
+
+                // create a user with a different display_name
+                $u = $this->factory->user->create( array(
+                        'user_login'   => 'foo',
+                        'display_name' => 'Foo Person'
+                ) );
+
+                // Get the result of a non-default, but acceptable input for 'show' parameter to wp_dropdown_users().
+                $found = wp_dropdown_users( array(
+                        'echo' => false,
+                        'show' => 'user_login'
+                ) );
+
+                $expected = "<option value='$u'>foo</option>";
+
+                $this->assertContains( $expected, $found );
+        }
+
+        /**
+         * @ticket 31251
+         */
+        public function test_show_should_display_display_name_and_user_in_parenthesis_when_show_an_invalid_user_property() {
+
+                // create a user with a different display_name
+                $u = $this->factory->user->create( array(
+                        'user_login'   => 'foo',
+                        'display_name' => 'Foo Person'
+                ) );
+
+                // Get the result of a non-default, but acceptable input for 'show' parameter to wp_dropdown_users().
+                $found = wp_dropdown_users( array(
+                        'echo' => false,
+                        'show' => 'foobar'
+                ) );
+
+                $expected = "<option value='$u'>Foo Person (foo)</option>";
+
+                $this->assertContains( $expected, $found );
+        }
+
+}
+ No newline at end of file