bbp_title( string $title = '', string $sep = '»', string $seplocation = '' )
Custom page title for bbPress pages
Description Description
Parameters 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'. separator and separator location
Default value: ''
Return Return
(string) The title
Source Source
File: includes/common/template.php
function bbp_title( $title = '', $sep = '»', $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', 'bbpress' ); // Topic edit page } elseif ( bbp_is_topic_edit() ) { $new_title['text'] = bbp_get_topic_title(); $new_title['format'] = esc_attr__( 'Topic Edit: %s', 'bbpress' ); // Reply edit page } elseif ( bbp_is_reply_edit() ) { $new_title['text'] = bbp_get_reply_title(); $new_title['format'] = esc_attr__( 'Reply Edit: %s', 'bbpress' ); // Topic tag edit page } elseif ( bbp_is_topic_tag_edit() ) { $new_title['text'] = bbp_get_topic_tag_name(); $new_title['format'] = esc_attr__( 'Topic Tag Edit: %s', 'bbpress' ); /** Singles ***************************************************************/ // Forum page } elseif ( bbp_is_single_forum() ) { $new_title['text'] = bbp_get_forum_title(); $new_title['format'] = esc_attr__( 'Forum: %s', 'bbpress' ); // Topic page } elseif ( bbp_is_single_topic() ) { $new_title['text'] = bbp_get_topic_title(); $new_title['format'] = esc_attr__( 'Topic: %s', 'bbpress' ); // 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__( 'Topic Tag: %s', 'bbpress' ); /** Users *****************************************************************/ // Profile page } elseif ( bbp_is_single_user() ) { // Is user viewing their own profile? $is_user_home = bbp_is_user_home(); // User topics created if ( bbp_is_single_user_topics() ) { if ( true === $is_user_home ) { $new_title['text'] = esc_attr__( 'Your Topics', 'bbpress' ); } else { $new_title['text'] = get_userdata( bbp_get_user_id() )->display_name; /* translators: user's display name */ $new_title['format'] = esc_attr__( "%s's Topics", 'bbpress' ); } // User replies created } elseif ( bbp_is_single_user_replies() ) { if ( true === $is_user_home ) { $new_title['text'] = esc_attr__( 'Your Replies', 'bbpress' ); } else { $new_title['text'] = get_userdata( bbp_get_user_id() )->display_name; /* translators: user's display name */ $new_title['format'] = esc_attr__( "%s's Replies", 'bbpress' ); } // User favorites } elseif ( bbp_is_favorites() ) { if ( true === $is_user_home ) { $new_title['text'] = esc_attr__( 'Your Favorites', 'bbpress' ); } else { $new_title['text'] = get_userdata( bbp_get_user_id() )->display_name; /* translators: user's display name */ $new_title['format'] = esc_attr__( "%s's Favorites", 'bbpress' ); } // User subscriptions } elseif ( bbp_is_subscriptions() ) { if ( true === $is_user_home ) { $new_title['text'] = esc_attr__( 'Your Subscriptions', 'bbpress' ); } else { $new_title['text'] = get_userdata( bbp_get_user_id() )->display_name; /* translators: user's display name */ $new_title['format'] = esc_attr__( "%s's Subscriptions", 'bbpress' ); } // User "home" } else { if ( true === $is_user_home ) { $new_title['text'] = esc_attr__( 'Your Profile', 'bbpress' ); } else { $new_title['text'] = get_userdata( bbp_get_user_id() )->display_name; /* translators: user's display name */ $new_title['format'] = esc_attr__( "%s's Profile", 'bbpress' ); } } // 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', 'bbpress' ); // Other user } else { $new_title['text'] = get_userdata( bbp_get_user_id() )->display_name; $new_title['format'] = esc_attr__( "Edit %s's Profile", 'bbpress' ); } /** Views *****************************************************************/ // Views } elseif ( bbp_is_single_view() ) { $new_title['text'] = bbp_get_view_title(); $new_title['format'] = esc_attr__( 'View: %s', 'bbpress' ); /** 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 & return return apply_filters( 'bbp_title', $new_title, $sep, $seplocation ); }
Changelog Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |