Changeset 10043

Timestamp:

08/11/2015 04:54:03 PM (10 years ago)

Author:

r-a-y

Message:

BP User Query: Remove invalid IDs from $user_ids property after query is run.

If the user_ids parameter is passed to BP_User_Query with invalid user
IDs, after the user query is run, the user_ids property still references
these invalid user IDs. This can lead to devs to assume that the user ID
exists when it does not.

This commit removes these invalid user IDs and includes a unit test.

See #6577.

Location:

trunk

Files:

• src/bp-core/classes/class-bp-user-query.php (modified) (2 diffs)
• tests/phpunit/testcases/core/class-bp-user-query.php (modified) (1 diff)

trunk/src/bp-core/classes/class-bp-user-query.php

@@ -596 +596 @@
 
         // Match up to the user ids from the main query
-        foreach ( $this->user_ids as $uid ) {
+        foreach ( $this->user_ids as $key => $uid ) {
             if ( isset( $r[ $uid ] ) ) {
                 $this->results[ $uid ] = $r[ $uid ];
@@ -603 +603 @@
                 // (as opposed to 'ID') property
                 $this->results[ $uid ]->id = $uid;
+
+            // remove user ID from original user_ids property
+            } else {
+                unset( $this->user_ids[ $key ] );
             }
         }

trunk/tests/phpunit/testcases/core/class-bp-user-query.php

@@ -67 +67 @@
     }
 
+    /**
+     * @group user_ids
+     */
+    public function test_bp_user_query_user_ids_with_invalid_user_id() {
+        $now = time();
+        $u1 = $this->factory->user->create();
+        $u2 = $this->factory->user->create();
+
+        // invalid user ID
+        $u3 = $u2 + 1;
+
+        $old_user = get_current_user_id();
+        $this->set_current_user( $u1 );
+
+        // pass 'user_ids' to user query to trigger this bug
+        $q = new BP_User_Query( array(
+            'user_ids' => array( $u2, $u3 )
+        ) );
+
+        // $q->user_ids property should now not contain invalid user IDs
+        $this->assertNotContains( $u3, $q->user_ids );
+
+        // clean up
+        $this->set_current_user( $old_user );
+    }
+
     public function test_bp_user_query_sort_by_popular() {
         $u1 = $this->factory->user->create();