bp_is_groups_directory()

Is the current page the groups directory?

Description

Return

(bool) True if the current page is the groups directory.

Source

function bp_is_groups_directory() {
    if ( bp_is_groups_component() && ! bp_is_group() && ( ! bp_current_action() || ( bp_action_variable() && bp_is_current_action( bp_get_groups_group_type_base() ) ) ) ) {
        return true;
    }
 
    return false;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.0.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_get_groups_group_type_base()	Get the group type base slug.
bp-core/bp-core-template.php: bp_is_group()	Does the current page belong to a single group?
bp-core/bp-core-template.php: bp_is_groups_component()	Check whether the current page is part of the Groups component.
bp-core/bp-core-template.php: bp_is_current_action()	Check to see whether the current page matches a given action.
bp-core/bp-core-template.php: bp_action_variable()	Return the value of a given action variable.
bp-core/bp-core-template.php: bp_current_action()	Return the name of the current action.

Show 1 more use Hide more uses

Used By
Used By	Description
bp-integrations/learndash/bp-learndash-filters.php: bb_group_wp_admin_bar_updates_menu()	Learndash Plugin updates Group Page admin bar Edit link to dashboard home page instead of the platform groups page.
bp-groups/bp-groups-functions.php: bp_groups_exclude_group_type()	Excludes specific group types from search and listing.
bp-groups/screens/directory.php: groups_directory_groups_setup()	Handle the display of the Groups directory index.
bp-groups/classes/class-bp-groups-theme-compat.php: BP_Groups_Theme_Compat::is_group()	Are we looking at something that needs group theme compatibility?
bp-groups/classes/class-bp-groups-component.php: BP_Groups_Component::late_includes()	Late includes method.
bp-groups/classes/class-bp-groups-component.php: BP_Groups_Component::setup_globals()	Set up component global data.
bp-groups/bp-groups-functions.php: bp_is_my_groups_view()	Check if this is a user’s “My Groups” view? This can happen on the main directory or at a user’s profile (/members/username/groups/).
bp-groups/bp-groups-template.php: bp_has_groups()	Start the Groups Template Loop.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_get_nav_classes()	Retrieve a space separated list of classes for the current nav item.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_get_loop_classes()	Get the component’s loop classes
bp-templates/bp-nouveau/buddypress-functions.php: BP_Nouveau::setup_directory_nav()	Define the directory nav items
bp-core/bp-core-template.php: bp_get_the_body_class()	Customize the body class, according to the currently displayed BP content.

Show 7 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents