Skip to:
Content

BuddyPress.org

Changeset 6711


Ignore:
Timestamp:
01/07/2013 02:11:50 PM (12 years ago)
Author:
boonebgorges
Message:

Allow groups_get_group_members() to have access to all params of wrapped method

Fixes #4753

Props chrisclayton

Adds documentation for groups_get_group_members()

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/bp-groups/bp-groups-functions.php

    r6574 r6711  
    380380}
    381381
    382 function groups_get_group_members( $group_id, $limit = false, $page = false ) {
    383     return BP_Groups_Member::get_all_for_group( $group_id, $limit, $page );
     382/**
     383 * Fetch the members of a group
     384 *
     385 * Procedural wrapper for BP_Groups_Member::get_all_for_group().
     386 *
     387 * @param int $group_id
     388 * @param int $limit Maximum members to return
     389 * @param int $page The page of results to return (requires $limit)
     390 * @param bool $exclude_admins_mods Whether to exclude admins and mods
     391 * @param bool $exclude_banned Whether to exclude banned users
     392 * @param array|string $exclude Array or comma-sep list of users to exclude
     393 * @return array Multi-d array of 'members' list and 'count'
     394 */
     395function groups_get_group_members( $group_id, $limit = false, $page = false, $exclude_admins_mods = true, $exclude_banned = true, $exclude = false ) {
     396    return BP_Groups_Member::get_all_for_group( $group_id, $limit, $page, $exclude_admins_mods, $exclude_banned, $exclude );
    384397}
    385398
Note: See TracChangeset for help on using the changeset viewer.