Changeset 9977 for trunk/src/bp-members/bp-members-functions.php
- Timestamp:
- 06/29/2015 03:06:53 PM (10 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-members/bp-members-functions.php
r9976 r9977 79 79 * Array of arguments. All are optional. See {@link BP_User_Query} for 80 80 * a more complete description of arguments. 81 * @type string $type Sort order. Default: 'active'.82 * @type int $user_id Limit results to friends of a user. Default: false.83 * @type mixed $exclude IDs to exclude from results. Default: false.84 * @type string $search_terms Limit to users matching search terms. Default: false.85 * @type string $meta_key Limit to users with a meta_key. Default: false.86 * @type string $meta_value Limit to users with a meta_value (with meta_key). Default: false.87 * @type array|string $member_type Array or comma-separated string of member types.88 * @type array|string $member_type__in Array or comma-separated string of member types.89 * `$member_type` takes precedence over this parameter.81 * @type string $type Sort order. Default: 'active'. 82 * @type int $user_id Limit results to friends of a user. Default: false. 83 * @type mixed $exclude IDs to exclude from results. Default: false. 84 * @type string $search_terms Limit to users matching search terms. Default: false. 85 * @type string $meta_key Limit to users with a meta_key. Default: false. 86 * @type string $meta_value Limit to users with a meta_value (with meta_key). Default: false. 87 * @type array|string $member_type Array or comma-separated string of member types. 88 * @type array|string $member_type__in Array or comma-separated string of member types. 89 * `$member_type` takes precedence over this parameter. 90 90 * @type array|string $member_type__not_in Array or comma-separated string of member types to be excluded. 91 * @type mixed $include Limit results by user IDs. Default: false.92 * @type int $per_page Results per page. Default: 20.93 * @type int $page Page of results. Default: 1.94 * @type bool $populate_extras Fetch optional extras. Default: true.95 * @type string|bool $count_total How to do total user count. Default: 'count_query'.91 * @type mixed $include Limit results by user IDs. Default: false. 92 * @type int $per_page Results per page. Default: 20. 93 * @type int $page Page of results. Default: 1. 94 * @type bool $populate_extras Fetch optional extras. Default: true. 95 * @type string|bool $count_total How to do total user count. Default: 'count_query'. 96 96 * } 97 97 * @return array … … 101 101 // Parse the user query arguments 102 102 $r = bp_parse_args( $args, array( 103 'type' => 'active', // active, newest, alphabetical, random or popular104 'user_id' => false, // Pass a user_id to limit to only friend connections for this user105 'exclude' => false, // Users to exclude from results106 'search_terms' => false, // Limit to users that match these search terms107 'meta_key' => false, // Limit to users who have this piece of usermeta108 'meta_value' => false, // With meta_key, limit to users where usermeta matches this value109 'member_type' => '',110 'member_type__in' => '',103 'type' => 'active', // active, newest, alphabetical, random or popular 104 'user_id' => false, // Pass a user_id to limit to only friend connections for this user 105 'exclude' => false, // Users to exclude from results 106 'search_terms' => false, // Limit to users that match these search terms 107 'meta_key' => false, // Limit to users who have this piece of usermeta 108 'meta_value' => false, // With meta_key, limit to users where usermeta matches this value 109 'member_type' => '', 110 'member_type__in' => '', 111 111 'member_type__not_in' => '', 112 'include' => false, // Pass comma separated list of user_ids to limit to only these users113 'per_page' => 20, // The number of results to return per page114 'page' => 1, // The page to return if limiting per page115 'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update116 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false112 'include' => false, // Pass comma separated list of user_ids to limit to only these users 113 'per_page' => 20, // The number of results to return per page 114 'page' => 1, // The page to return if limiting per page 115 'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update 116 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false 117 117 ), 'core_get_users' ); 118 118
Note: See TracChangeset
for help on using the changeset viewer.