Changeset 27185

Timestamp:

02/17/2014 09:40:04 PM (11 years ago)

Author:

wonderboymusic

Message:

Make WP_User_Query::prepare_query() public by allowing it to be passed an array of args. Previously, if the WP_User_Query constructor was not passed args, the object was basically unusable. Adds unit tests, all other tests pass.

Props scribu, for the initial patch.
Fixes #21119.

Location:

trunk

Files:

• src/wp-includes/user.php (modified) (4 diffs)
• tests/phpunit/tests/user/query.php (modified) (2 diffs)

trunk/src/wp-includes/user.php

@@ -432 +432 @@
      */
     function __construct( $query = null ) {
-        if ( !empty( $query ) ) {
+        if ( ! empty( $query ) ) {
+            $this->prepare_query( $query );
+            $this->query();
+        }
+    }
+
+    /**
+     * Prepare the query variables
+     *
+     * @since 3.1.0
+     *
+     * @param string|array $args The query variables
+     */
+    function prepare_query( $query = array() ) {
+        global $wpdb;
+
+        if ( empty( $this->query_vars ) || ! empty( $query ) ) {
+            $this->query_limit = null;
             $this->query_vars = wp_parse_args( $query, array(
                 'blog_id' => $GLOBALS['blog_id'],
@@ -451 +468 @@
                 'who' => ''
             ) );
-
-            $this->prepare_query();
-            $this->query();
-        }
-    }
-
-    /**
-     * Prepare the query variables
-     *
-     * @since 3.1.0
-     * @access private
-     */
-    function prepare_query() {
-        global $wpdb;
+        }
 
         $qv =& $this->query_vars;
@@ -650 +654 @@
      *
      * @since 3.1.0
-     * @access private
      */
     function query() {
@@ -657 +660 @@
         $qv =& $this->query_vars;
 
+        $query = "SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit";
+
         if ( is_array( $qv['fields'] ) || 'all' == $qv['fields'] ) {
-            $this->results = $wpdb->get_results("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
+            $this->results = $wpdb->get_results( $query );
         } else {
-            $this->results = $wpdb->get_col("SELECT $this->query_fields $this->query_from $this->query_where $this->query_orderby $this->query_limit");
+            $this->results = $wpdb->get_col( $query );
         }
 

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

@@ -44 +44 @@
         $ids = $users->get_results();
         $this->assertEquals( array( $this->user_id ), $ids );
-
     }
 
@@ -102 +101 @@
         $this->assertEquals( $names, $values );
     }
+
+    function test_prepare_query() {
+        $query = new WP_User_Query();
+        $this->assertEmpty( $query->query_fields );
+        $this->assertEmpty( $query->query_from );
+        $this->assertEmpty( $query->query_limit );
+        $this->assertEmpty( $query->query_orderby );
+        $this->assertEmpty( $query->query_where );
+        $this->assertEmpty( $query->query_vars );
+        $_query_vars = $query->query_vars;
+
+        $query->prepare_query();
+        $this->assertNotEmpty( $query->query_fields );
+        $this->assertNotEmpty( $query->query_from );
+        $this->assertEmpty( $query->query_limit );
+        $this->assertNotEmpty( $query->query_orderby );
+        $this->assertNotEmpty( $query->query_where );
+        $this->assertNotEmpty( $query->query_vars );
+        $this->assertNotEquals( $_query_vars, $query->query_vars );
+
+        // All values get reset
+        $query->prepare_query( array( 'number' => 8 ) );
+        $this->assertNotEmpty( $query->query_limit );
+        $this->assertEquals( 'LIMIT 8', $query->query_limit );
+
+        // All values get reset
+        $query->prepare_query( array( 'fields' => 'all' ) );
+        $this->assertEmpty( $query->query_limit );
+        $this->assertEquals( '', $query->query_limit );
+        $_query_vars = $query->query_vars;
+
+        $query->prepare_query();
+        $this->assertEquals( $_query_vars, $query->query_vars );
+    }
 }