bp_core_get_users (|字符串数组args美元＝＇＇）
根据传递的参数获取用户数组。
描述
自从BuddyPress 1.7,bp_core_get_users ()使用BP_User_Query．如果你需要向后兼容BP_Core_User: get_user ()，过滤bp_use_legacy_user_query值，返回true。
参数
- args美元
-
（数组|字符串）(可选)数组的参数。都是可选的。看到BP_User_Query以获得更完整的参数描述。
- “类型”
(字符串)排序顺序。默认值:“活跃”。 - “user_id”
(int)限制结果给用户的朋友。默认值:false。 - “排除”
(混合)要从结果中排除的id。默认值:false。 - “search_term”
(字符串)限制用户匹配搜索条件。默认值:false。 - “meta_key”
(字符串)限制使用meta_key的用户。默认值:false。 - “meta_value”
(字符串)限制使用meta_value(使用meta_key)的用户。默认值:false。 - “member_type”
(数组|字符串)配置文件类型的数组或逗号分隔的字符串。 - “member_type__in”
(数组|字符串)配置文件类型的数组或逗号分隔的字符串。member_type美元优先于此参数。 - “member_type__not_in”
(数组|字符串)要排除的概要文件类型的数组或逗号分隔的字符串。 - “包括”
(混合)根据用户id限制结果。默认值:false。 - “per_page”
(int)结果每个页面。默认值:20。 - “页面”
(int)页的搜索结果。默认值:1。 - “populate_extras”
(保龄球)获取任选附件。默认值:真的。 - “count_total”
(字符串| bool)如何计算用户总数。默认值:“count_query”。
默认值:“
- “类型”
返回
(数组)
源
文件:bp-members / bp-members-functions.php
function bp_core_get_users($args = "){//解析用户查询参数。$r = bp_parse_args($args, array('type' => 'active'， //活跃的，最新的，按字母顺序排列的，随机的或流行的。'user_id' => false， //传递一个user_id来限制这个用户的朋友连接。'exclude' => false， //从结果中排除的用户。'search_terms' => false， //限制匹配这些搜索项的用户。'meta_key' => false， //限制拥有此usermeta的用户。'meta_value' => false， //使用meta_key，限制usermeta匹配该值的用户。'member_type' => "， 'member_type__in' => "， 'member_type__not_in' => "， 'include' => false， //通过逗号分隔的user_ids列表，只限制这些用户。'per_page' => 20， //每个页面返回的结果数量。'page' => 1， //如果限制每页返回的页面。 'populate_extras' => true, // Fetch the last active, where the user is a friend, total friend count, latest update. 'count_total' => 'count_query' // What kind of total user count to do, if any. 'count_query', 'sql_calc_found_rows', or false. ), 'core_get_users' ); // For legacy users. Use of BP_Core_User::get_users() is deprecated. if ( apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, $r ) ) { $retval = BP_Core_User::get_users( $r['type'], $r['per_page'], $r['page'], $r['user_id'], $r['include'], $r['search_terms'], $r['populate_extras'], $r['exclude'], $r['meta_key'], $r['meta_value'] ); // Default behavior as of BuddyPress 1.7.0. } else { // Get users like we were asked to do... $users = new BP_User_Query( $r ); // ...but reformat the results to match bp_core_get_users() behavior. $retval = array( 'users' => array_values( $users->results ), 'total' => $users->total_users ); } /** * Filters the results of the user query. * * @since BuddyPress 1.2.0 * * @param array $retval Array of users for the current query. * @param array $r Array of parsed query arguments. */ return apply_filters( 'bp_core_get_users', $retval, $r ); }
更新日志
| 版本 | 描述 |
|---|---|
| BuddyPress 1.2.0 | 介绍了。 |