Contents

Code Reference Functions bbp_body_class()

bbp_body_class( array $wp_classes, array $custom_classes = false )

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

Description

Parameters

$wp_classes

(Required)

$custom_classes

(Optional)

Default value: false

Return

(array) Body Classes

Source

File: bp-forums/common/template.php

987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
function bbp_body_class( $wp_classes, $custom_classes = false ) {
 
    $bbp_classes = array();
 
    /** Archives **************************************************************/
 
    if ( bbp_is_forum_archive() ) {
        $bbp_classes[] = bbp_get_forum_post_type() . '-archive';
 
    } elseif ( bbp_is_topic_archive() ) {
        $bbp_classes[] = bbp_get_topic_post_type() . '-archive';
 
    /** Topic Tags ************************************************************/
 
    } elseif ( bbp_is_topic_tag() ) {
        $bbp_classes[] = bbp_get_topic_tag_tax_id();
        $bbp_classes[] = bbp_get_topic_tag_tax_id() . '-' . bbp_get_topic_tag_slug();
        $bbp_classes[] = bbp_get_topic_tag_tax_id() . '-' . bbp_get_topic_tag_id();
    } elseif ( bbp_is_topic_tag_edit() ) {
        $bbp_classes[] = bbp_get_topic_tag_tax_id() . '-edit';
        $bbp_classes[] = bbp_get_topic_tag_tax_id() . '-' . bbp_get_topic_tag_slug() . '-edit';
        $bbp_classes[] = bbp_get_topic_tag_tax_id() . '-' . bbp_get_topic_tag_id()   . '-edit';
 
    /** Components ************************************************************/
 
    } elseif ( bbp_is_single_forum() ) {
        $bbp_classes[] = bbp_get_forum_post_type();
 
    } elseif ( bbp_is_single_topic() ) {
        $bbp_classes[] = bbp_get_topic_post_type();
 
    } elseif ( bbp_is_single_reply() ) {
        $bbp_classes[] = bbp_get_reply_post_type();
 
    } elseif ( bbp_is_topic_edit() ) {
        $bbp_classes[] = bbp_get_topic_post_type() . '-edit';
 
    } elseif ( bbp_is_topic_merge() ) {
        $bbp_classes[] = bbp_get_topic_post_type() . '-merge';
 
    } elseif ( bbp_is_topic_split() ) {
        $bbp_classes[] = bbp_get_topic_post_type() . '-split';
 
    } elseif ( bbp_is_reply_edit() ) {
        $bbp_classes[] = bbp_get_reply_post_type() . '-edit';
 
    } elseif ( bbp_is_reply_move() ) {
        $bbp_classes[] = bbp_get_reply_post_type() . '-move';
 
    } elseif ( bbp_is_single_view() ) {
        $bbp_classes[] = 'bbp-view';
 
    /** User ******************************************************************/
 
    } elseif ( bbp_is_single_user_edit() ) {
        $bbp_classes[] = 'bbp-user-edit';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    } elseif ( bbp_is_single_user() ) {
        $bbp_classes[] = 'bbp-user-page';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    } elseif ( bbp_is_user_home() ) {
        $bbp_classes[] = 'bbp-user-home';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    } elseif ( bbp_is_user_home_edit() ) {
        $bbp_classes[] = 'bbp-user-home-edit';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    } elseif ( bbp_is_topics_created() ) {
        $bbp_classes[] = 'bbp-topics-created';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    } elseif ( bbp_is_favorites() ) {
        $bbp_classes[] = 'bbp-favorites';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    } elseif ( bbp_is_subscriptions() ) {
        $bbp_classes[] = 'bbp-subscriptions';
        $bbp_classes[] = 'single';
        $bbp_classes[] = 'singular';
 
    /** Search ****************************************************************/
 
    } elseif ( bbp_is_search() ) {
        $bbp_classes[] = 'bbp-search';
        $bbp_classes[] = 'forum-search';
 
    } elseif ( bbp_is_search_results() ) {
        $bbp_classes[] = 'bbp-search-results';
        $bbp_classes[] = 'forum-search-results';
    }
 
    /** Clean up **************************************************************/
 
    // Add Forums class if we are within a Forums page
    if ( !empty( $bbp_classes ) ) {
        $bbp_classes[] = 'bbpress';
    }
 
    // Merge WP classes with Forums classes and remove any duplicates
    $classes = array_unique( array_merge( (array) $bbp_classes, (array) $wp_classes ) );
 
    // Deprecated filter (do not use)
    $classes = apply_filters( 'bbp_get_the_body_class', $classes, $bbp_classes, $wp_classes, $custom_classes );
 
    return apply_filters( 'bbp_body_class', $classes, $bbp_classes, $wp_classes, $custom_classes );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r2926) Introduced.

Uses

Uses
Uses Description
bp-forums/topics/template.php: bbp_get_topic_tag_slug()

Return the slug of the current tag
bp-forums/topics/template.php: bbp_get_topic_tag_tax_id()

Return the unique id of the topic tag taxonomy
bp-forums/topics/template.php: bbp_get_topic_tag_id()

Return the id of the current tag
bp-forums/topics/template.php: bbp_get_topic_post_type()

Return the unique id of the custom post type for topics
bp-forums/forums/template.php: bbp_get_forum_post_type()

Return the unique id of the custom post type for forums
bp-forums/common/template.php: bbp_is_single_view()

Check if current page is a view page
bp-forums/common/template.php: bbp_is_single_user_edit()

Check if current page is a user profile edit page
bp-forums/common/template.php: bbp_is_single_user()

Check if current page is a user profile page
bp-forums/common/template.php: bbp_is_search()

Check if current page is a search page
bp-forums/common/template.php: bbp_is_search_results()

Check if current page is a search results page
bp-forums/common/template.php: bbp_get_the_body_class

Archives
bp-forums/common/template.php: bbp_is_single_reply()

Viewing a single reply
bp-forums/common/template.php: bbp_is_user_home()

Check if current page is the currently logged in users author page
bp-forums/common/template.php: bbp_is_user_home_edit()

Check if current page is the currently logged in users author edit page
bp-forums/common/template.php: bbp_is_topics_created()

Check if current page shows the topics created by a Forums user (profile page)
bp-forums/common/template.php: bbp_is_favorites()

Check if current page is a Forums user’s favorites page (profile page)
bp-forums/common/template.php: bbp_is_subscriptions()

Check if current page is a Forums user’s subscriptions page (profile page)
bp-forums/common/template.php: bbp_is_reply_edit()

Check if current page is a reply edit page
bp-forums/common/template.php: bbp_is_reply_move()

Check if current page is a reply move page
bp-forums/common/template.php: bbp_is_topic_archive()

Check if we are viewing a topic archive.
bp-forums/common/template.php: bbp_is_topic_tag()

Check if the current page is a topic tag
bp-forums/common/template.php: bbp_is_topic_tag_edit()

Check if the current page is editing a topic tag
bp-forums/common/template.php: bbp_is_single_topic()

Viewing a single topic
bp-forums/common/template.php: bbp_is_topic_edit()

Check if current page is a topic edit page
bp-forums/common/template.php: bbp_is_topic_merge()

Check if current page is a topic merge page
bp-forums/common/template.php: bbp_is_topic_split()

Check if current page is a topic split page
bp-forums/common/template.php: bbp_is_forum_archive()

Check if we are viewing a forum archive.
bp-forums/common/template.php: bbp_is_single_forum()

Viewing a single forum
bp-forums/replies/template.php: bbp_get_reply_post_type()

Return the unique id of the custom post type for replies
Show 24 more uses Hide more uses

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.