friends_get_alphabetically (intuser_id美元,intper_page美元,int美元的页面,字符串美元的过滤器=”)
按字母顺序获取用户的好友。
描述
另请参阅
- BP_Core_User: get_user ():用于描述返回值。
参数
- user_id美元
-
(int)(必需)正在检索其朋友的用户的ID。
- per_page美元
-
(int)(可选)每页返回的结果数。默认值:0(没有分页;显示所有结果)。
- 美元的页面
-
(int)(可选)要返回的结果页的编号。默认值:0(没有分页;显示所有结果)。
- 美元的过滤器
-
(字符串)(可选)将结果限制为匹配搜索字符串的结果。
默认值:“
返回
(数组)看到BP_Core_User: get_user ().
源
文件:bp-friends / bp-friends-functions.php
Function friends_get_alphabetically($user_id, $per_page = 0, $page = 0, $filter = ") {$friends = bp_core_get_users(array('type' => 'alphabetical', 'per_page' => $per_page, 'page' => $page, 'user_id' => $user_id, 'search_terms' => $filter,));/** *按字母顺序过滤用户的好友。* * @since BuddyPress 1.2.0 * * @return array $friends {* @type int $total_users查询参数匹配的用户总数。* @type array $paged_users查询参数匹配的用户的当前页面。*} */返回apply_filters('friends_get_alphabetically', $friends);}
更新日志
版本 | 描述 |
---|---|
BuddyPress 1.0.0 | 介绍了。 |