Changeset 38715

Timestamp:

10/04/2016 02:26:26 AM (8 years ago)

Author:

boonebgorges

Message:

Query: Add nicename and login params to user query.

New parameters are: login, login__in, login__not_in, nicename,
nicename__in, nicename__not_in.

login__in and nicename__in are also now valid values for the
'orderby' parameter.

Props ryanplas.
Fixes #36624.

Location:

trunk

Files:

• src/wp-includes/class-wp-user-query.php (modified) (7 diffs)
• tests/phpunit/tests/user/query.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-user-query.php

@@ -125 +125 @@
             'who' => '',
             'has_published_posts' => null,
+            'nicename' => '',
+            'nicename__in' => array(),
+            'nicename__not_in' => array(),
+            'login' => '',
+            'login__in' => array(),
+            'login__not_in' => array()
         );
 
@@ -141 +147 @@
      *              permit an array or comma-separated list of values. The 'number' parameter was updated to support
      *              querying for all users with using -1.
+     * @since 4.7.0 Added 'nicename', 'nicename__in', 'nicename__not_in', 'login', 'login__in',
+     *              and 'login__not_in' parameters.
      *
      * @access public
@@ -174 +182 @@
      *                                             keys and orders ('ASC' or 'DESC') as values. Accepted values are
      *                                             'ID', 'display_name' (or 'name'), 'include', 'user_login'
-     *                                             (or 'login'), 'user_nicename' (or 'nicename'), 'user_email'
-     *                                             (or 'email'), 'user_url' (or 'url'), 'user_registered'
-     *                                             or 'registered'), 'post_count', 'meta_value', 'meta_value_num',
-     *                                             the value of `$meta_key`, or an array key of `$meta_query`. To use
-     *                                             'meta_value' or 'meta_value_num', `$meta_key` must be also be
-     *                                             defined. Default 'user_login'.
+     *                                             (or 'login'), 'login__in', 'user_nicename' (or 'nicename'),
+     *                                             'nicename__in', 'user_email (or 'email'), 'user_url' (or 'url'),
+     *                                             'user_registered' (or 'registered'), 'post_count', 'meta_value',
+     *                                             'meta_value_num', the value of `$meta_key`, or an array key of
+     *                                             `$meta_query`. To use 'meta_value' or 'meta_value_num', `$meta_key`
+     *                                             must be also be defined. Default 'user_login'.
      *     @type string       $order               Designates ascending or descending order of users. Order values
      *                                             passed as part of an `$orderby` array take precedence over this
@@ -204 +212 @@
      *                                             published posts in those post types. `true` is an alias for all
      *                                             public post types.
+     *     @type string       $nicename            The user nicename. Default empty.
+     *     @type array        $nicename__in        An array of nicenames to include. Users matching one of these
+     *                                             nicenames will be included in results. Default empty array.
+     *     @type array        $nicename__not_in    An array of nicenames to exclude. Users matching one of these
+     *                                             nicenames will not be included in results. Default empty array.
+     *     @type string       $login               The user login. Default empty.
+     *     @type array        $login__in           An array of logins to include. Users matching one of these
+     *                                             logins will be included in results. Default empty array.
+     *     @type array        $login__not_in       An array of logins to exclude. Users matching one of these
+     *                                             logins will not be included in results. Default empty array.
      * }
      */
@@ -277 +295 @@
         }
 
+        // nicename
+        if ( '' !== $qv['nicename']) {
+            $this->query_where .= $this->db->prepare( ' AND user_nicename = %s', $qv['nicename'] );
+        }
+
+        if ( ! empty( $qv['nicename__in'] ) ) {
+            $sanitized_nicename__in = array_map( 'esc_sql', $qv['nicename__in'] );
+            $nicename__in = implode( "','", $sanitized_nicename__in );
+            $this->query_where .= " AND user_nicename IN ( '$nicename__in' )";
+        }
+
+        if ( ! empty( $qv['nicename__not_in'] ) ) {
+            $sanitized_nicename__not_in = array_map( 'esc_sql', $qv['nicename__not_in'] );
+            $nicename__not_in = implode( "','", $sanitized_nicename__not_in );
+            $this->query_where .= " AND user_nicename NOT IN ( '$nicename__not_in' )";
+        }
+
+        // login
+        if ( '' !== $qv['login']) {
+            $this->query_where .= $this->db->prepare( ' AND user_login = %s', $qv['login'] );
+        }
+
+        if ( ! empty( $qv['login__in'] ) ) {
+            $sanitized_login__in = array_map( 'esc_sql', $qv['login__in'] );
+            $login__in = implode( "','", $sanitized_login__in );
+            $this->query_where .= " AND user_login IN ( '$login__in' )";
+        }
+
+        if ( ! empty( $qv['login__not_in'] ) ) {
+            $sanitized_login__not_in = array_map( 'esc_sql', $qv['login__not_in'] );
+            $login__not_in = implode( "','", $sanitized_login__not_in );
+            $this->query_where .= " AND user_login NOT IN ( '$login__not_in' )";
+        }
+
         // Meta query.
         $this->meta_query = new WP_Meta_Query();
@@ -435 +487 @@
             }
 
-            $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+            if ( 'nicename__in' === $_orderby || 'login__in' === $_orderby ) {
+                $orderby_array[] = $parsed;
+            } else {
+                $orderby_array[] = $parsed . ' ' . $this->parse_order( $_order );
+            }
         }
 
@@ -701 +757 @@
             $include_sql = implode( ',', $include );
             $_orderby = "FIELD( {$this->db->users}.ID, $include_sql )";
+        } elseif ( 'nicename__in' === $orderby ) {
+            $sanitized_nicename__in = array_map( 'esc_sql', $this->query_vars['nicename__in'] );
+            $nicename__in = implode( "','", $sanitized_nicename__in );
+            $_orderby = "FIELD( user_nicename, '$nicename__in' )";
+        } elseif ( 'login__in' === $orderby ) {
+            $sanitized_login__in = array_map( 'esc_sql', $this->query_vars['login__in'] );
+            $login__in = implode( "','", $sanitized_login__in );
+            $_orderby = "FIELD( user_login, '$login__in' )";
         } elseif ( isset( $meta_query_clauses[ $orderby ] ) ) {
             $meta_clause = $meta_query_clauses[ $orderby ];

trunk/tests/phpunit/tests/user/query.php

@@ -879 +879 @@
 
     /**
+     * @ticket 36624
+     */
+    public function test_nicename_returns_user_with_nicename() {
+        wp_update_user( array(
+            'ID' => self::$author_ids[0],
+            'user_nicename' => 'peter'
+        ) );
+
+        $q = new WP_User_Query( array (
+            'nicename' => 'peter'
+        ) );
+
+        $found = wp_list_pluck( $q->get_results(), 'ID' );
+        $expected = array( self::$author_ids[0] );
+
+        $this->assertContains( "AND user_nicename = 'peter'", $q->query_where);
+        $this->assertEqualSets( $expected, $found);
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_nicename__in_returns_users_with_included_nicenames() {
+        wp_update_user( array(
+            'ID' => self::$author_ids[0],
+            'user_nicename' => 'peter'
+        ) );
+
+        wp_update_user( array(
+            'ID' => self::$author_ids[1],
+            'user_nicename' => 'paul'
+        ) );
+
+        wp_update_user( array(
+            'ID' => self::$author_ids[2],
+            'user_nicename' => 'mary'
+        ) );
+
+        $q = new WP_User_Query( array (
+            'nicename__in' => array( 'peter', 'paul', 'mary' )
+        ) );
+
+        $found = wp_list_pluck( $q->get_results(), 'ID' );
+        $expected = array( self::$author_ids[0], self::$author_ids[1], self::$author_ids[2] );
+
+        $this->assertContains( "AND user_nicename IN ( 'peter','paul','mary' )", $q->query_where);
+        $this->assertEqualSets( $expected, $found );
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_nicename__not_in_returns_users_without_included_nicenames() {
+        wp_update_user( array(
+            'ID' => self::$author_ids[0],
+            'user_nicename' => 'peter'
+        ) );
+
+        wp_update_user( array(
+            'ID' => self::$author_ids[1],
+            'user_nicename' => 'paul'
+        ) );
+
+        wp_update_user( array(
+            'ID' => self::$author_ids[2],
+            'user_nicename' => 'mary'
+        ) );
+
+        $q = new WP_User_Query( array (
+            'nicename__not_in' => array( 'peter', 'paul', 'mary' )
+        ) );
+
+        $foundCount = count($q->get_results());
+        $expectedCount = 10; // 13 total users minus 3 from query
+
+        $this->assertContains( "AND user_nicename NOT IN ( 'peter','paul','mary' )", $q->query_where);
+        $this->assertEquals( $expectedCount, $foundCount );
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_orderby_nicename__in() {
+        wp_update_user( array(
+            'ID' => self::$author_ids[0],
+            'user_nicename' => 'peter'
+        ) );
+
+        wp_update_user( array(
+            'ID' => self::$author_ids[1],
+            'user_nicename' => 'paul'
+        ) );
+
+        wp_update_user( array(
+            'ID' => self::$author_ids[2],
+            'user_nicename' => 'mary'
+        ) );
+
+        $q = new WP_User_Query( array (
+            'nicename__in' => array( 'mary', 'peter', 'paul' ),
+            'orderby' => 'nicename__in'
+        ) );
+
+        $found = wp_list_pluck( $q->get_results(), 'ID' );
+        $expected = array( self::$author_ids[2], self::$author_ids[0], self::$author_ids[1] );
+
+        $this->assertContains( "FIELD( user_nicename, 'mary','peter','paul' )", $q->query_orderby);
+        $this->assertSame( $expected, $found );
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_login_returns_user_with_login() {
+
+        $user_login = get_userdata( self::$author_ids[0] )->user_login;
+
+        $q = new WP_User_Query( array (
+            'login' => $user_login
+        ) );
+
+        $found = wp_list_pluck( $q->get_results(), 'ID' );
+        $expected = array( self::$author_ids[0] );
+
+        $this->assertContains( "AND user_login = '$user_login'", $q->query_where);
+        $this->assertEqualSets( $expected, $found);
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_login__in_returns_users_with_included_logins() {
+        $user_login1 = get_userdata( self::$author_ids[0] )->user_login;
+        $user_login2 = get_userdata( self::$author_ids[1] )->user_login;
+        $user_login3 = get_userdata( self::$author_ids[2] )->user_login;
+
+        $q = new WP_User_Query( array (
+            'login__in' => array( $user_login1, $user_login2, $user_login3 )
+        ) );
+
+        $found = wp_list_pluck( $q->get_results(), 'ID' );
+        $expected = array( self::$author_ids[0], self::$author_ids[1], self::$author_ids[2] );
+
+        $this->assertContains( "AND user_login IN ( '$user_login1','$user_login2','$user_login3' )", $q->query_where);
+        $this->assertEqualSets( $expected, $found );
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_login__not_in_returns_users_without_included_logins() {
+        $user_login1 = get_userdata( self::$author_ids[0] )->user_login;
+        $user_login2 = get_userdata( self::$author_ids[1] )->user_login;
+        $user_login3 = get_userdata( self::$author_ids[2] )->user_login;
+
+        $q = new WP_User_Query( array (
+            'login__not_in' => array( $user_login1, $user_login2, $user_login3 )
+        ) );
+
+        $foundCount = count($q->get_results());
+        $expectedCount = 10; // 13 total users minus 3 from query
+
+        $this->assertContains( "AND user_login NOT IN ( '$user_login1','$user_login2','$user_login3' )", $q->query_where);
+        $this->assertEquals( $expectedCount, $foundCount );
+    }
+
+    /**
+     * @ticket 36624
+     */
+    public function test_orderby_login__in() {
+        $user_login1 = get_userdata( self::$author_ids[0] )->user_login;
+        $user_login2 = get_userdata( self::$author_ids[1] )->user_login;
+        $user_login3 = get_userdata( self::$author_ids[2] )->user_login;
+
+        $q = new WP_User_Query( array (
+            'login__in' => array( $user_login2, $user_login3, $user_login1 ),
+            'orderby' => 'login__in'
+        ) );
+
+        $found = wp_list_pluck( $q->get_results(), 'ID' );
+        $expected = array( self::$author_ids[1], self::$author_ids[2], self::$author_ids[0] );
+
+        $this->assertContains( "FIELD( user_login, '$user_login2','$user_login3','$user_login1' )", $q->query_orderby);
+        $this->assertSame( $expected, $found );
+    }
+
+    /**
      * @ticket 25145
      */