bbp_title( string $title = '', string $sep = '»', string $seplocation = '' )

Custom page title for Forums pages

Description

Parameters

$title

(Optional) The title (not used).

Default value: ''

$sep

(Optional) default is '»'. How to separate the various items within the page title.

Default value: '»'

$seplocation

(Optional) Direction to display title, 'right'.

Default value: ''

Return

(string) The tite

Source

File: bp-forums/common/template.php

function bbp_title( $title = '', $sep = '&raquo;', $seplocation = '' ) {
 
    // Title array
    $new_title = array();
 
    /** Archives **************************************************************/
 
    // Forum Archive
    if ( bbp_is_forum_archive() ) {
        $new_title['text'] = bbp_get_forum_archive_title();
 
    // Topic Archive
    } elseif ( bbp_is_topic_archive() ) {
        $new_title['text'] = bbp_get_topic_archive_title();
 
    /** Edit ******************************************************************/
 
    // Forum edit page
    } elseif ( bbp_is_forum_edit() ) {
        $new_title['text']   = bbp_get_forum_title();
        $new_title['format'] = esc_attr__( 'Forum Edit: %s', 'buddyboss' );
 
    // Topic edit page
    } elseif ( bbp_is_topic_edit() ) {
        $new_title['text']   = bbp_get_topic_title();
        $new_title['format'] = esc_attr__( 'Discussion Edit: %s', 'buddyboss' );
 
    // Reply edit page
    } elseif ( bbp_is_reply_edit() ) {
        $new_title['text']   = bbp_get_reply_title();
        $new_title['format'] = esc_attr__( 'Reply Edit: %s', 'buddyboss' );
 
    // Topic tag edit page
    } elseif ( bbp_is_topic_tag_edit() ) {
        $new_title['text']   = bbp_get_topic_tag_name();
        $new_title['format'] = esc_attr__( 'Discussion Tag Edit: %s', 'buddyboss' );
 
    /** Singles ***************************************************************/
 
    // Forum page
    } elseif ( bbp_is_single_forum() ) {
        $new_title['text']   = bbp_get_forum_title();
        $new_title['format'] = esc_attr__( 'Forum: %s', 'buddyboss' );
 
    // Topic page
    } elseif ( bbp_is_single_topic() ) {
        $new_title['text']   = bbp_get_topic_title();
        $new_title['format'] = esc_attr__( 'Discussion: %s', 'buddyboss' );
 
    // Replies
    } elseif ( bbp_is_single_reply() ) {
        $new_title['text']   = bbp_get_reply_title();
 
    // Topic tag page
    } elseif ( bbp_is_topic_tag() || get_query_var( 'bbp_topic_tag' ) ) {
        $new_title['text']   = bbp_get_topic_tag_name();
        $new_title['format'] = esc_attr__( 'Discussion Tag: %s', 'buddyboss' );
 
    /** Users *****************************************************************/
 
    // Profile page
    } elseif ( bbp_is_single_user() ) {
 
        // User is viewing their own profile
        if ( bbp_is_user_home() ) {
            $new_title['text'] = esc_attr_x( 'Your', 'User viewing his/her own profile', 'buddyboss' );
 
        // User is viewing someone else's profile (so use their display name)
        } else {
            $new_title['text'] = sprintf( esc_attr_x( "%s's", 'User viewing another users profile', 'buddyboss' ), get_userdata( bbp_get_user_id() )->display_name );
        }
 
        // User topics created
        if ( bbp_is_single_user_topics() ) {
            $new_title['format'] = esc_attr__( "%s Discussions",        'buddyboss' );
 
        // User rueplies created
        } elseif ( bbp_is_single_user_replies() ) {
            $new_title['format'] = esc_attr__( "%s Replies",       'buddyboss' );
 
        // User favorites
        } elseif ( bbp_is_favorites() ) {
            $new_title['format'] = esc_attr__( "%s Saved",     'buddyboss' );
 
        // User subscriptions
        } elseif ( bbp_is_subscriptions() ) {
            $new_title['format'] = esc_attr__( "%s Subscriptions", 'buddyboss' );
 
        // User "home"
        } else {
            $new_title['format'] = esc_attr__( "%s Profile",       'buddyboss' );
        }
 
    // Profile edit page
    } elseif ( bbp_is_single_user_edit() ) {
 
        // Current user
        if ( bbp_is_user_home_edit() ) {
            $new_title['text']   = esc_attr__( 'Edit Your Profile', 'buddyboss' );
 
        // Other user
        } else {
            $new_title['text']   = get_userdata( bbp_get_user_id() )->display_name;
            $new_title['format'] = esc_attr__( "Edit %s's Profile", 'buddyboss' );
        }
 
    /** Views *****************************************************************/
 
    // Views
    } elseif ( bbp_is_single_view() ) {
        $new_title['text']   = bbp_get_view_title();
        $new_title['format'] = esc_attr__( 'View: %s', 'buddyboss' );
 
    /** Search ****************************************************************/
 
    // Search
    } elseif ( bbp_is_search() ) {
        $new_title['text'] = bbp_get_search_title();
    }
 
    // This filter is deprecated. Use 'bbp_before_title_parse_args' instead.
    $new_title = apply_filters( 'bbp_raw_title_array', $new_title );
 
    // Set title array defaults
    $new_title = bbp_parse_args( $new_title, array(
        'text'   => $title,
        'format' => '%s'
    ), 'title' );
 
    // Get the formatted raw title
    $new_title = sprintf( $new_title['format'], $new_title['text'] );
 
    // Filter the raw title
    $new_title = apply_filters( 'bbp_raw_title', $new_title, $sep, $seplocation );
 
    // Compare new title with original title
    if ( $new_title === $title )
        return $title;
 
    // Temporary separator, for accurate flipping, if necessary
    $t_sep  = '%WP_TITILE_SEP%';
    $prefix = '';
 
    if ( !empty( $new_title ) )
        $prefix = " $sep ";
 
    // sep on right, so reverse the order
    if ( 'right' === $seplocation ) {
        $new_title_array = array_reverse( explode( $t_sep, $new_title ) );
        $new_title       = implode( " $sep ", $new_title_array ) . $prefix;
 
    // sep on left, do not reverse
    } else {
        $new_title_array = explode( $t_sep, $new_title );
        $new_title       = $prefix . implode( " $sep ", $new_title_array );
    }
 
    // Filter and return
    return apply_filters( 'bbp_title', $new_title, $sep, $seplocation );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2788)	Introduced.

Uses

Uses
Uses	Description
bp-forums/topics/template.php: bbp_get_topic_tag_name()	Return the name of the current tag
bp-forums/topics/template.php: bbp_get_topic_archive_title()	Return the topic archive title
bp-forums/topics/template.php: bbp_get_topic_title()	Return the title of the topic
bp-forums/users/template.php: bbp_get_user_id()	Return a validated user id
bp-forums/forums/template.php: bbp_get_forum_archive_title()	Return the forum archive title
bp-forums/forums/template.php: bbp_get_forum_title()	Return the title of the forum
bp-forums/common/template.php: bbp_get_view_title()	Get the view name aka title
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_single_user_topics()	Check if current page is a user topics created page
bp-forums/common/template.php: bbp_is_single_user_replies()	Check if current page is a user replies created 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_view()	Check if current page is a view page
bp-forums/common/template.php: bbp_is_search()	Check if current page is a search page
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_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_user_home_edit()	Check if current page is the currently logged in users author edit 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_topic_archive()	Check if we are viewing a topic archive.
bp-forums/common/template.php: bbp_is_forum_edit()	Check if current page is a forum edit page
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_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_tag()	Check if the current page is a topic tag
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/common/functions.php: bbp_parse_args()	Merge user defined arguments into defaults array.
bp-forums/replies/template.php: bbp_get_reply_title()	Return the title of the reply
bp-forums/search/template.php: bbp_get_search_title()	Get the search page title

Show 25 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.

Contents