bp_get_the_body_class( array $wp_classes = array(), array|bool $custom_classes = false )

Customize the body class, according to the currently displayed BP content.

Description

Uses the above is_() functions to output a body class for each scenario.

Parameters

$wp_classes

(Optional) The body classes coming from WP.

Default value: array()

$custom_classes

(Optional) Classes that were passed to get_body_class().

Default value: false

Return

(array) $classes The BP-adjusted body classes.

Source

File: bp-core/bp-core-template.php

function bp_get_the_body_class( $wp_classes = array(), $custom_classes = false ) {
 
    $bp_classes = array();
 
    /* Pages *************************************************************/
 
    if ( is_front_page() ) {
        $bp_classes[] = 'home-page';
    }
 
    if ( bp_is_directory() ) {
        $bp_classes[] = 'directory';
    }
 
    if ( bp_is_single_item() ) {
        $bp_classes[] = 'single-item';
    }
 
    /* Components ********************************************************/
 
    if ( ! bp_is_blog_page() ) {
        if ( bp_is_user_profile() )  {
            $bp_classes[] = 'xprofile';
        }
 
        if ( bp_is_activity_component() ) {
            $bp_classes[] = 'activity';
        }
 
        if ( bp_is_blogs_component() ) {
            $bp_classes[] = 'blogs';
        }
 
        if ( bp_is_messages_component() ) {
            $bp_classes[] = 'messages';
        }
 
        if ( bp_is_friends_component() ) {
            $bp_classes[] = 'friends';
        }
 
        if ( bp_is_groups_component() ) {
            $bp_classes[] = 'groups';
        }
 
        if ( bp_is_settings_component()  ) {
            $bp_classes[] = 'settings';
        }
 
        if ( bp_is_invites_component() ) {
            $bp_classes[] = 'invites';
        }
    }
 
    /* User **************************************************************/
 
    if ( bp_is_user() ) {
        $bp_classes[] = 'bp-user';
 
        // Add current user profile types.
        if ( $member_types = bp_get_member_type( bp_displayed_user_id(), false ) ) {
            foreach( $member_types as $member_type ) {
                $bp_classes[] = sprintf( 'member-type-%s', esc_attr( $member_type ) );
            }
        }
    }
 
    if ( ! bp_is_directory() ) {
        if ( bp_is_user_blogs() ) {
            $bp_classes[] = 'my-blogs';
        }
 
        if ( bp_is_user_groups() ) {
            $bp_classes[] = 'my-groups';
        }
 
        if ( bp_is_user_activity() ) {
            $bp_classes[] = 'my-activity';
        }
    } else {
        if ( bp_get_current_member_type() || ( bp_is_groups_directory() && bp_get_current_group_directory_type() ) ) {
            $bp_classes[] = 'type';
        }
    }
 
    if ( bp_is_my_profile() ) {
        $bp_classes[] = 'my-account';
    }
 
    if ( bp_is_user_profile() ) {
        $bp_classes[] = 'my-profile';
    }
 
    if ( bp_is_user_friends() ) {
        $bp_classes[] = 'my-friends';
    }
 
    if ( bp_is_user_messages() ) {
        $bp_classes[] = 'my-messages';
    }
 
    if ( bp_is_user_recent_commments() ) {
        $bp_classes[] = 'recent-comments';
    }
 
    if ( bp_is_user_recent_posts() ) {
        $bp_classes[] = 'recent-posts';
    }
 
    if ( bp_is_user_change_avatar() ) {
        $bp_classes[] = 'change-avatar';
    }
 
    if ( bp_is_user_profile_edit() ) {
        $bp_classes[] = 'profile-edit';
    }
 
    if ( bp_is_user_friends_activity() ) {
        $bp_classes[] = 'friends-activity';
    }
 
    if ( bp_is_user_groups_activity() ) {
        $bp_classes[] = 'groups-activity';
    }
 
    /* Messages **********************************************************/
 
    if ( bp_is_messages_inbox() ) {
        $bp_classes[] = 'inbox';
    }
 
    if ( bp_is_messages_compose_screen() ) {
        $bp_classes[] = 'compose';
    }
 
    if ( bp_is_notices() ) {
        $bp_classes[] = 'notices';
    }
 
    if ( bp_is_user_friend_requests() ) {
        $bp_classes[] = 'friend-requests';
    }
 
    if ( bp_is_create_blog() ) {
        $bp_classes[] = 'create-blog';
    }
 
    /* Groups ************************************************************/
 
    if ( bp_is_group() ) {
        $bp_classes[] = 'group-' . groups_get_current_group()->slug;
 
        // Add current group types.
        if ( $group_types = bp_groups_get_group_type( bp_get_current_group_id(), false ) ) {
            foreach ( $group_types as $group_type ) {
                $bp_classes[] = sprintf( 'group-type-%s', esc_attr( $group_type ) );
            }
        }
    }
 
    if ( bp_is_group_leave() ) {
        $bp_classes[] = 'leave-group';
    }
 
    if ( bp_is_group_invites() ) {
        $bp_classes[] = 'group-invites';
    }
 
    if ( bp_is_group_members() ) {
        $bp_classes[] = 'group-members';
    }
 
    if ( bp_is_group_admin_page() ) {
        $bp_classes[] = 'group-admin';
        $bp_classes[] = bp_get_group_current_admin_tab();
    }
 
    if ( bp_is_group_create() ) {
        $bp_classes[] = 'group-create';
        $bp_classes[] = bp_get_groups_current_create_step();
    }
 
    if ( bp_is_group_home() ) {
        $bp_classes[] = 'group-home';
    }
 
    if ( bp_is_single_activity() ) {
        $bp_classes[] = 'activity-permalink';
    }
 
    /* Registration ******************************************************/
 
    if ( bp_is_register_page() ) {
        $bp_classes[] = 'registration';
    }
 
    if ( bp_is_activation_page() ) {
        $bp_classes[] = 'activation';
    }
 
    /* Current Component & Action ****************************************/
 
    if ( ! bp_is_blog_page() ) {
        $bp_classes[] = bp_current_component();
        $bp_classes[] = str_replace(',', ' ', bp_current_action());
    }
 
    /* Clean up ***********************************************************/
 
    // Add BuddyPress class if we are within a BuddyPress page.
    if ( ! bp_is_blog_page() ) {
        $bp_classes[] = 'buddypress';
    }
 
    // Add the theme name/id to the body classes
    $bp_classes[] = 'bp-' . bp_get_theme_compat_id();
 
    // Merge WP classes with BuddyPress classes and remove any duplicates.
    $classes = array_unique( array_merge( (array) $bp_classes, (array) $wp_classes ) );
 
    /**
     * Filters the BuddyPress classes to be added to body_class()
     *
     * @since BuddyPress 1.1.0
     *
     * @param array $classes        Array of body classes to add.
     * @param array $bp_classes     Array of BuddyPress-based classes.
     * @param array $wp_classes     Array of WordPress-based classes.
     * @param array $custom_classes Array of classes that were passed to get_body_class().
     */
    return apply_filters( 'bp_get_the_body_class', $classes, $bp_classes, $wp_classes, $custom_classes );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.1.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_get_group_current_invite_tab()	Returns the current group invite tab slug.
bp-groups/bp-groups-functions.php: bp_get_current_group_directory_type()	Get the “current” group type, if one is provided, in group directories.
bp-groups/bp-groups-functions.php: bp_groups_get_group_type()	Get type for a group.
bp-groups/bp-groups-functions.php: groups_get_current_group()	Get the BP_Groups_Group object corresponding to the current group.
bp-groups/bp-groups-template.php: bp_get_current_group_id()	Returns the ID of the current group.
bp-groups/bp-groups-template.php: bp_get_group_current_admin_tab()	Returns the current group admin tab slug.
bp-groups/bp-groups-template.php: bp_get_groups_current_create_step()	Returns the current group creation step. If none is found, returns an empty string.
bp-members/bp-members-functions.php: bp_get_member_type()	Get type for a member.
bp-members/bp-members-functions.php: bp_get_current_member_type()	Get the “current” profile type, if one is provided, in member directories.
bp-core/bp-core-theme-compatibility.php: bp_get_theme_compat_id()	Get the ID of the theme package being used.
bp-core/bp-core-template.php: bp_is_register_page()	Is the current page the Register page?
bp-core/bp-core-template.php: bp_is_activation_page()	Is the current page the Activate page?
bp-core/bp-core-template.php: bp_get_the_body_class	Filters the BuddyPress classes to be added to body_class()
bp-core/bp-core-template.php: bp_is_user_messages()	Is the current page part of a user’s Messages pages?
bp-core/bp-core-template.php: bp_is_messages_inbox()	Is the current page a user’s Messages Inbox?
bp-core/bp-core-template.php: bp_is_messages_compose_screen()	Is the current page a user’s Messages Compose screen??
bp-core/bp-core-template.php: bp_is_notices()	Is the current page the Notices screen?
bp-core/bp-core-template.php: bp_is_create_blog()	Is the current page the Create a Blog page?
bp-core/bp-core-template.php: bp_is_group_leave()	Is the current page a leave group attempt?
bp-core/bp-core-template.php: bp_is_group_invites()	Is the current page a group’s Invites page?
bp-core/bp-core-template.php: bp_is_group_members()	Is the current page a group’s Members page?
bp-core/bp-core-template.php: bp_is_group_admin_page()	Is the current page part of a single group’s admin screens?
bp-core/bp-core-template.php: bp_is_group_create()	Is the current page part of the group creation process?
bp-core/bp-core-template.php: bp_is_groups_directory()	Is the current page the groups directory?
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_group_home()	Is the current page a single group’s home page?
bp-core/bp-core-template.php: bp_is_user_friend_requests()	Is the current page a user’s Connection Requests page?
bp-core/bp-core-template.php: bp_is_user_friends()	Is the current page a user’s Connections page?
bp-core/bp-core-template.php: bp_is_user_profile()	Is the current page part of a user’s extended profile?
bp-core/bp-core-template.php: bp_is_user_blogs()	Is the current page part of a user’s Blogs page?
bp-core/bp-core-template.php: bp_is_user_groups()	Is the current page part of a user’s Groups page?
bp-core/bp-core-template.php: bp_is_user_recent_commments()	Is the current page a user’s Recent Blog Comments page?
bp-core/bp-core-template.php: bp_is_user_recent_posts()	Is the current page a user’s Recent Blog Posts page?
bp-core/bp-core-template.php: bp_is_user_change_avatar()	Is the current page part of a user’s profile avatar editing section?
bp-core/bp-core-template.php: bp_is_user_profile_edit()	Is the current page part of a user’s profile editing section?
bp-core/bp-core-template.php: bp_is_user_friends_activity()	Is the current page a user’s Connections activity feed?
bp-core/bp-core-template.php: bp_is_user_groups_activity()	Is the current page a user’s Groups activity feed?
bp-core/bp-core-template.php: bp_is_user()	Is the current page a user page?
bp-core/bp-core-template.php: bp_is_user_activity()	Is the current page a user’s activity feed page?
bp-core/bp-core-template.php: bp_is_invites_component()	Check whether the current page is part of the Invites component.
bp-core/bp-core-template.php: bp_is_my_profile()	Is the current page part of the profile of the logged-in user?
bp-core/bp-core-template.php: bp_is_single_activity()	Is the current page a single activity item permalink?
bp-core/bp-core-template.php: bp_is_activity_component()	Check whether the current page is part of the Activity component.
bp-core/bp-core-template.php: bp_is_blogs_component()	Check whether the current page is part of the Blogs component.
bp-core/bp-core-template.php: bp_is_messages_component()	Check whether the current page is part of the Messages component.
bp-core/bp-core-template.php: bp_is_friends_component()	Check whether the current page is part of the Connections component.
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_settings_component()	Check whether the current page is part of the Settings component.
bp-core/bp-core-template.php: bp_is_directory()	Is this a component directory page?
bp-core/bp-core-template.php: bp_is_blog_page()	Is this a blog page, ie a non-BP page?
bp-core/bp-core-template.php: bp_is_single_item()	Are we looking at a single item? (group, user, etc).
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.
bp-core/bp-core-template.php: bp_current_component()	Return the name of the current component.
bp-core/bp-core-template.php: bp_current_action()	Return the name of the current action.

Show 49 more uses Hide more uses

Used By
Used By	Description
bp-core/bp-core-template.php: bp_the_body_class()	Customize the body class, according to the currently displayed BP content.

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