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
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 ); }
Changelog
Version | Description |
---|---|
bbPress (r2926) | Introduced. |
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.