Changeset 2702 for trunk/bp-core.php

Timestamp:

02/12/2010 02:14:20 PM (16 years ago)

Author:

apeatling

Message:

Fixing up API so it is consistent for get_users, get_groups and get_blogs.

File:

• trunk/bp-core.php (modified) (2 diffs)

trunk/bp-core.php

@@ -520 +520 @@
 
 /**
+ * bp_core_get_users()
+ *
+ * Return an array of users IDs based on the parameters passed.
+ *
+ * @package BuddyPress Core
+ */
+function bp_core_get_users( $args = '' ) {
+    global $bp;
+
+    $defaults = array(
+        'type' => 'active', // active, newest, alphabetical, random or popular
+        'user_id' => false, // Pass a user_id to limit to only friend connections for this user
+        'search_terms' => false, // Limit to users that match these search terms
+
+        'per_page' => 20, // The number of results to return per page
+        'page' => 1, // The page to return if limiting per page
+        'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update
+    );
+
+    $params = wp_parse_args( $args, $defaults );
+    extract( $params, EXTR_SKIP );
+
+    return apply_filters( 'bp_core_get_users', BP_Core_User::get_users( $type, $per_page, $page, $user_id, $search_terms, $populate_extras ), &$params );
+}
+
+/**
  * bp_core_get_user_domain()
  *
@@ -954 +980 @@
 
     if ( isset( $_GET['random-member'] ) ) {
-        $user = BP_Core_User::get_users( 'random', 1 );
+        $user = bp_core_get_users( array( 'type' => 'random', 'per_page' => 1 ) );
         bp_core_redirect( bp_core_get_user_domain( $user['users'][0]->id ) );
     }