Changeset 2702 for trunk/bp-groups.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-groups.php (modified) (3 diffs)

trunk/bp-groups.php

@@ -1721 +1721 @@
 /*** Group Fetching, Filtering & Searching  *************************************/
 
-function groups_get_all( $limit = null, $page = 1, $only_public = false, $sort_by = false, $order = false ) {
-    return BP_Groups_Group::get_all( $limit, $page, $only_public, $sort_by, $order );
-}
-
-/***
- * All of the following get_() functions will return groups for the site globally.
- * If you pass a $user_id then the groups will be restricted to only those that the
- * user has joined.
- */
-function groups_get_newest( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_newest( $limit, $page, $user_id, $search_terms, $populate_extras );
-}
-
-function groups_get_active( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_active( $limit, $page, $user_id, $search_terms, $populate_extras );
-}
-
-function groups_get_popular( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_popular( $limit, $page, $user_id, $search_terms, $populate_extras );
-}
-
-function groups_get_random_groups( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_random( $limit, $page, $user_id, $search_terms, $populate_extras );
-}
-
-function groups_get_alphabetically( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_alphabetically( $limit, $page, $user_id, $search_terms, $populate_extras );
-}
-
-function groups_get_by_most_forum_topics( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_by_most_forum_topics( $limit, $page, $user_id, $search_terms, $populate_extras );
-}
-
-function groups_get_by_most_forum_posts( $limit = null, $page = 1, $user_id = false, $search_terms = false, $populate_extras = true ) {
-    return BP_Groups_Group::get_by_most_forum_posts( $limit, $page, $user_id, $search_terms, $populate_extras );
+function groups_get_groups( $args = '' ) {
+    global $bp;
+
+    $defaults = array(
+        'type' => 'active', // active, newest, alphabetical, random, popular, most-forum-topics or most-forum-posts
+        'user_id' => false, // Pass a user_id to limit to only groups that this user is a member of
+        'search_terms' => false, // Limit to groups 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 meta such as is_banned and is_member
+    );
+
+    $params = wp_parse_args( $args, $defaults );
+    extract( $params, EXTR_SKIP );
+
+    switch ( $type ) {
+        case 'active': default:
+            $groups = BP_Groups_Group::get_active( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+        case 'newest':
+            $groups = BP_Groups_Group::get_newest( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+        case 'popular':
+            $groups = BP_Groups_Group::get_popular( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+        case 'alphabetical':
+            $groups = BP_Groups_Group::get_alphabetically( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+        case 'random':
+            $groups = BP_Groups_Group::get_random( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+        case 'most-forum-topics':
+            $groups = BP_Groups_Group::get_by_most_forum_topics( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+        case 'most-forum-posts':
+            $groups = BP_Groups_Group::get_by_most_forum_posts( $limit, $page, $user_id, $search_terms, $populate_extras );
+            break;
+    }
+
+    return apply_filters( 'groups_get_groups', $groups, &$params );
 }
 
@@ -1776 +1782 @@
 }
 
-function groups_get_recently_joined_for_user( $user_id = false, $pag_num = false, $pag_page = false, $filter = false ) {
-    global $bp;
-
-    if ( !$user_id )
-        $user_id = $bp->displayed_user->id;
-
-    return BP_Groups_Member::get_recently_joined( $user_id, $pag_num, $pag_page, $filter );
-}
-
-function groups_get_user_is_admin_of( $user_id = false, $pag_num = false, $pag_page = false, $filter = false ) {
-    global $bp;
-
-    if ( !$user_id )
-        $user_id = $bp->displayed_user->id;
-
-    return BP_Groups_Member::get_is_admin_of( $user_id, $pag_num, $pag_page, $filter );
-}
-
-function groups_get_user_is_mod_of( $user_id = false, $pag_num = false, $pag_page = false, $filter = false ) {
-    global $bp;
-
-    if ( !$user_id )
-        $user_id = $bp->displayed_user->id;
-
-    return BP_Groups_Member::get_is_mod_of( $user_id, $pag_num, $pag_page, $filter );
-}
-
 function groups_total_groups_for_user( $user_id = false ) {
     global $bp;
@@ -1815 +1794 @@
 
     return $count;
-}
-
-function groups_search_groups( $search_terms, $pag_num_per_page = 5, $pag_page = 1, $sort_by = false, $order = false ) {
-    return BP_Groups_Group::search_groups( $search_terms, $pag_num_per_page, $pag_page, $sort_by, $order );
-}
-
-function groups_filter_user_groups( $filter, $user_id = false, $order = false, $pag_num_per_page = 5, $pag_page = 1 ) {
-    return BP_Groups_Group::filter_user_groups( $filter, $user_id, $order, $pag_num_per_page, $pag_page );
 }