Changeset 38651

Timestamp:

09/25/2016 05:44:24 PM (8 years ago)

Author:

boonebgorges

Message:

Allow 'role' parameters to be passed to wp_dropdown_users().

wp_dropdown_users() contains a whitelist of function params that are
passed through to get_users(). role, role__in, and role__not_in
have now been added to this whitelist.

Props sillybean.
Fixes #38135.

Location:

trunk

Files:

• src/wp-includes/user.php (modified) (4 diffs)
• tests/phpunit/tests/user/wpDropdownUsers.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -965 +965 @@
  * @since 2.3.0
  * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
+ * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters.
  *
  * @param array|string $args {
@@ -1005 +1006 @@
  *     @type string       $who                     Which type of users to query. Accepts only an empty string or
  *                                                 'authors'. Default empty.
+ *     @type string|array $role                    An array or a comma-separated list of role names that users must
+ *                                                 match to be included in results. Note that this is an inclusive
+ *                                                 list: users must match *each* role. Default empty.
+ *     @type array        $role__in                An array of role names. Matched users must have at least one of
+ *                                                 these roles. Default empty array.
+ *     @type array        $role__not_in            An array of role names to exclude. Users matching one or more of
+ *                                                 these roles will not be included in results. Default empty array.
  * }
  * @return string String of HTML content.
@@ -1016 +1024 @@
         'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
         'blog_id' => get_current_blog_id(), 'who' => '', 'include_selected' => false,
-        'option_none_value' => -1
+        'option_none_value' => -1,
+        'role' => '',
+        'role__in' => array(),
+        'role__not_in' => array(),
     );
 
@@ -1023 +1034 @@
     $r = wp_parse_args( $args, $defaults );
 
-    $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
+    $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) );
 
     $fields = array( 'ID', 'user_login' );

trunk/tests/phpunit/tests/user/wpDropdownUsers.php

@@ -111 +111 @@
         $this->assertContains( $user1->user_login, $found );
     }
+
+    /**
+     * @ticket 38135
+     */
+    public function test_role() {
+        $u1 = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+        $u2 = self::factory()->user->create_and_get( array( 'role' => 'author' ) );
+
+        $found = wp_dropdown_users( array(
+            'echo' => false,
+            'role' => 'author',
+            'show' => 'user_login',
+        ) );
+
+        $this->assertNotContains( $u1->user_login, $found );
+        $this->assertContains( $u2->user_login, $found );
+    }
+
+    /**
+     * @ticket 38135
+     */
+    public function test_role__in() {
+        $u1 = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+        $u2 = self::factory()->user->create_and_get( array( 'role' => 'author' ) );
+
+        $found = wp_dropdown_users( array(
+            'echo' => false,
+            'role__in' => array( 'author', 'editor' ),
+            'show' => 'user_login',
+        ) );
+
+        $this->assertNotContains( $u1->user_login, $found );
+        $this->assertContains( $u2->user_login, $found );
+    }
+
+    /**
+     * @ticket 38135
+     */
+    public function test_role__not_in() {
+        $u1 = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+        $u2 = self::factory()->user->create_and_get( array( 'role' => 'author' ) );
+
+        $found = wp_dropdown_users( array(
+            'echo' => false,
+            'role__not_in' => array( 'subscriber', 'editor' ),
+            'show' => 'user_login',
+        ) );
+
+        $this->assertNotContains( $u1->user_login, $found );
+        $this->assertContains( $u2->user_login, $found );
+    }
 }