friends_search_friends (字符串search_term美元,intuser_id美元,intpag_num美元=10,intpag_page美元=1)
通过搜索字符串搜索用户的朋友。
描述
参数
- search_term美元
-
(字符串)(必需)搜索字符串,匹配xprofile字段(如果可用),或usermeta 'nickname'字段。
- user_id美元
-
(int)(必需)正在搜索好友的用户ID。
- pag_num美元
-
(int)(可选)返回的最大好友数。
默认值:10
- pag_page美元
-
(int)(可选)要返回的结果页面。默认值:null(不分页-返回所有结果)。
默认值:1
返回
(数组| bool)如果成功,则返回一个数组:{@type array $friends查询返回的好友id。@type int $count匹配搜索的朋友总数(不考虑分页)。}。失败时返回false。
源
文件:bp-friends / bp-friends-functions.php
function friends_search_friends($search_terms, $user_id, $pag_num = 10, $pag_page = 1){返回BP_Friends_Friendship::search_friends($search_terms, $user_id, $pag_num, $pag_page);}
更新日志
版本 | 描述 |
---|---|
BuddyPress 1.0.0 | 介绍了。 |