bp_is_directory()

Is this a component directory page?

Description

Return

(bool) True if the current page is a component directory, otherwise false.

Source

function bp_is_directory() {
    $bp     = buddypress();
    $retval = false;
 
    if ( isset( $bp->is_directory ) ) {
        $retval = $bp->is_directory;
    }
 
    /**
     * Filters whether or not user is on a component directory page.
     *
     * @since BuddyPress 2.1.0
     *
     * @param bool $retval Whether or not user is on a component directory page.
     */
    return (bool) apply_filters( 'bp_is_directory', $retval );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.0.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-core/bp-core-template.php: bp_is_directory	Filters whether or not user is on a component directory page.

Used By
Used By	Description
bp-messages/bp-messages-functions.php: bp_messages_show_sites_notices()	Display Sites notices on all the page
bp-members/bp-members-template.php: bp_get_loggedin_user_nav()	Render the navigation markup for the logged-in user.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_get_search_primary_object()	Get the search primary object
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_get_container_classes()	Returns the main BuddyPress container classes.
bp-templates/bp-nouveau/includes/template-tags.php: bp_nouveau_has_nav()	Init the Navigation Loop and check it has items.
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::theme_compat_page_templates()	Filter the default theme compatibility root template hierarchy, and prepend a page template to the front if it’s set.
bp-core/bp-core-template.php: bp_get_title_parts()	Get the title parts of the BuddyPress displayed page
bp-core/bp-core-template.php: bp_get_the_body_class()	Customize the body class, according to the currently displayed BP content.
bp-activity/classes/class-bp-activity-feed.php: BP_Activity_Feed::http_headers()	Sets various HTTP headers related to Content-Type and browser caching.

Show 5 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