bp_folder_get (|字符串数组args美元='')
检索一个或多个文件夹。
描述
的bp_folder_get ()函数共享所有参数BP_Document_Folder: get ().下面是一个列表bp_folder_get ()具有不同默认值的参数BP_Document_Folder: get ()的默认值bp_folder_get ()).
- “per_page”(假)
另请参阅
- BP_Document_Folder: get ():有关接受的参数和返回值格式的更多信息。
参数
- args美元
-
(数组|字符串)(可选)看到BP_Document_Folder: get ()为描述。
默认值:“
返回
(数组)活动看到美元BP_Document_Folder: get ()为描述。
源
文件:bp-document / bp-document-functions.php
function bp_folder_get($args = ") {$r = bp_parse_args($args, array('max' => false, //最大返回的结果数。'fields' => 'all', 'page' => 1, //没有per_page的page 1将不会导致分页。'per_page' => false, //每个页面的结果。'sort' => 'DESC', //排序ASC或DESC。'search_terms' => false, //将搜索项作为字符串传递。'exclude' => false, //以逗号分隔的要排除的活动id列表。//限制查询'user_id' => false, 'group_id' => false, 'privacy' => false, //文件夹的隐私。'count_total' => false,), 'folder_get');$文件夹= BP_Document_Folder: get(数组('页' = > $ r(“页”),“per_page”= > $ r(“per_page”),“user_id”= > $ r(“user_id”),“group_id”= > $ r(“group_id”),“隐私”= > $ r“隐私”,“马克斯”= > $ r(“max”),“排序”= > $ r(“排序”),“search_term”= > $ r(“search_term”),“排除”= > $ r“排除”,“count_total”= > $ r(“count_total”),“字段”= > $ r(“字段”), ) ); /** * Filters the requested folder item(s). * * @param BP_Document $folder Requested document object. * @param array $r Arguments used for the folder query. * * @since BuddyBoss 1.4.0 */ return apply_filters_ref_array( 'bp_folder_get', array( &$folder, &$r ) ); }
更新日志
版本 | 描述 |
---|---|
BuddyBoss 1.4.0 | 介绍了。 |