bp_include_group_by_context (对象| bool美元集团=假,int | booluser_id美元=假,字符串美元的上下文=“正常”)
确定在特定上下文中用户的结果集中是否应该包含一个组。
描述
参数
- 美元集团
-
(对象|保龄球)(可选)BP_Groups_Group检查对象。
默认值:假
- user_id美元
-
(int|保龄球)(可选)要检查组可见性的用户ID。
默认值:假
- 美元的上下文
-
(字符串)(可选)“normal”只过滤用户不属于的隐藏组。'activity'只包括用户应该看到活动流的组。'exclude_hidden'过滤掉所有隐藏的组(对于目录)。
默认值:“正常”
返回
(保龄球)如果组满足上下文要求,则为True。
源
文件:bp-groups / bp-groups-template.php
函数bp_include_group_by_context($group = false, $user_id = false, $context = 'normal') {$include = false;如果(!Isset ($group->id)) {return $include;} if (current_user_can('bp_moderate')) {$include = true;} /* * 'exclude_hidden'是有用的目录,隐藏组*被BP排除。*/ if ('exclude_hidden' == $context) {if ('hidden' != $group->status) {$include = true;} /* * 'activity'只包含用户可以查看activity流的组。*/} elseif ('activity' == $context){//对于activity流包含,需要公共状态或成员。If ('public' == $group->status || group_is_user_member ($user_id, $group->id)) {$include = true;} /* * 'mygroups'在用户特定的目录中是有用的,其中只返回*用户所属的组,并且组的状态是不相关的。 */ } elseif ( 'mygroups' == $context ) { if ( groups_is_user_member( $user_id, $group->id ) ) { $include = true; } } elseif ( 'normal' == $context ) { if ( 'hidden' != $group->status || groups_is_user_member( $user_id, $group->id ) ) { $include = true; } } /** * Filters whether this group should be included for this user and context combination. * * @since BuddyBoss 1.0.0 * * @param bool $include Whether to include this group. * @param BP_Groups_Group $group The group object in question. * @param int $user_id ID of user to check. * @param string $user_id Current context. */ return apply_filters( 'bp_include_group_by_context', $include, $group, $user_id, $context ); }
更新日志
版本 | 描述 |
---|---|
BuddyBoss 1.0.0 | 介绍了。 |