# bbpress/2.0-beta-3b/bbp-includes/bbp-common-template.php bbPress, version 2.0-beta-3b. 1,699 lines. - Page: https://pluginprobe.com/plugins/bbpress/2.0-beta-3b/code/bbp-includes/bbp-common-template.php - Raw: https://pluginprobe.com/plugins/bbpress/2.0-beta-3b/raw/bbp-includes/bbp-common-template.php - Modified: 2011-06-16T15:36:24+00:00 Line numbers below start at 1. Link to a line or a range by appending a fragment to the page URL, for example `https://pluginprobe.com/plugins/bbpress/2.0-beta-3b/code/bbp-includes/bbp-common-template.php#L10-L20`. ```php query_vars['post_type'] ) && ( bbp_get_forum_post_type() === $wp_query->query_vars['post_type'] ) ) return true; if ( isset( $bbp->forum_query->post->post_type ) && ( bbp_get_forum_post_type() === $bbp->forum_query->post->post_type ) ) return true; if ( isset( $_GET['post_type'] ) && !empty( $_GET['post_type'] ) && ( bbp_get_forum_post_type() === $_GET['post_type'] ) ) return true; } elseif ( !empty( $post_id ) && ( bbp_get_forum_post_type() == get_post_field( 'post_type', $post_id ) ) ) return true; return false; } /** * Check if we are viewing a forum archive. * * @since bbPress (r3251) * * @uses is_post_type_archive() To check if we are looking at the forum archive * @uses bbp_get_forum_post_type() To get the forum post type ID * * @return bool */ function bbp_is_forum_archive() { global $bbp; // Default to false $retval = false; // In forum archive if ( is_post_type_archive( bbp_get_forum_post_type() ) ) $retval = true; return apply_filters( 'bbp_is_forum_archive', (bool) $retval ); } /** * Check if current page is a bbPress topic * * @since bbPress (r2549) * * @param int $post_id Possible post_id to check * @uses bbp_is_topic_edit() To return false if it's a topic edit page * @uses bbp_get_topic_post_type() To get the topic post type * @uses is_singular() To check if it's the single post page * @uses get_post_field() To get the post type of the post id * @return bool True if it's a topic page, false if not */ function bbp_is_topic( $post_id = 0 ) { global $bbp, $wp_query; // Return false if it's a edit topic page if ( bbp_is_topic_edit() ) return false; if ( empty( $post_id ) ) { if ( is_singular( bbp_get_topic_post_type() ) ) return true; if ( isset( $wp_query->query_vars['post_type'] ) && ( bbp_get_topic_post_type() === $wp_query->query_vars['post_type'] ) ) return true; if ( isset( $_GET['post_type'] ) && !empty( $_GET['post_type'] ) && ( bbp_get_topic_post_type() === $_GET['post_type'] ) ) return true; } elseif ( !empty( $post_id ) && ( bbp_get_topic_post_type() == get_post_field( 'post_type', $post_id ) ) ) return true; return false; } /** * Check if we are viewing a topic archive. * * @since bbPress (r3251) * * @uses is_post_type_archive() To check if we are looking at the topic archive * @uses bbp_get_topic_post_type() To get the topic post type ID * * @return bool */ function bbp_is_topic_archive() { global $bbp; // Default to false $retval = false; // In topic archive if ( is_post_type_archive( bbp_get_topic_post_type() ) ) $retval = true; return apply_filters( 'bbp_is_topic_archive', (bool) $retval ); } /** * Check if current page is a topic edit page * * @since bbPress (r2753) * * @uses WP_Query Checks if WP_Query::bbp_is_topic_edit is true * @return bool True if it's the topic edit page, false if not */ function bbp_is_topic_edit() { global $wp_query; if ( !empty( $wp_query->bbp_is_topic_edit ) && $wp_query->bbp_is_topic_edit == true ) return true; return false; } /** * Check if current page is a topic merge page * * @since bbPress (r2756) * * @uses bbp_is_topic_edit() To check if it's a topic edit page * @return bool True if it's the topic merge page, false if not */ function bbp_is_topic_merge() { if ( bbp_is_topic_edit() && !empty( $_GET['action'] ) && ( 'merge' == $_GET['action'] ) ) return true; return false; } /** * Check if current page is a topic split page * * @since bbPress (r2756) * * @uses bbp_is_topic_edit() To check if it's a topic edit page * @return bool True if it's the topic split page, false if not */ function bbp_is_topic_split() { if ( bbp_is_topic_edit() && !empty( $_GET['action'] ) && ( 'split' == $_GET['action'] ) ) return true; return false; } /** * Check if the current page is a topic tag * * @since bbPress (r3311) * * @global bbPress $bbp * @return bool True if it's a topic tag, false if not */ function bbp_is_topic_tag() { global $bbp; if ( is_tax( $bbp->topic_tag_id ) ) return true; return false; } /** * Check if the current post type is one of bbPress's * * @since bbPress (r3311) * * @uses get_post_type() * @uses bbp_get_forum_post_type() * @uses bbp_get_topic_post_type() * @uses bbp_get_reply_post_type() * * @return bool */ function bbp_is_custom_post_type() { // Current post type $post_type = get_post_type(); // bbPress post types $bbp_post_types = array( bbp_get_forum_post_type(), bbp_get_topic_post_type(), bbp_get_reply_post_type() ); // Viewing one of the bbPress post types if ( in_array( $post_type, $bbp_post_types ) ) return true; return false; } /** * Check if current page is a bbPress reply * * @since bbPress (r2549) * * @param int $post_id Possible post_id to check * @uses bbp_is_reply_edit() To return false if it's a reply edit page * @uses bbp_get_reply_post_type() To get the reply post type * @uses is_singular() To check if it's the single post page * @uses get_post_field() To get the post type of the post id * @return bool True if it's a reply page, false if not */ function bbp_is_reply( $post_id = 0 ) { global $bbp, $wp_query; // Return false if it's a edit reply page if ( bbp_is_reply_edit() ) return false; if ( empty( $post_id ) ) { if ( is_singular( bbp_get_reply_post_type() ) ) return true; if ( isset( $wp_query->query_vars['post_type'] ) && ( bbp_get_reply_post_type() === $wp_query->query_vars['post_type'] ) ) return true; if ( isset( $_GET['post_type'] ) && !empty( $_GET['post_type'] ) && ( bbp_get_reply_post_type() === $_GET['post_type'] ) ) return true; } elseif ( !empty( $post_id ) && ( bbp_get_reply_post_type() == get_post_field( 'post_type', $post_id ) ) ) return true; return false; } /** * Check if current page is a reply edit page * * @since bbPress (r2753) * * @uses WP_Query Checks if WP_Query::bbp_is_reply_edit is true * @return bool True if it's the reply edit page, false if not */ function bbp_is_reply_edit() { global $wp_query; if ( !empty( $wp_query->bbp_is_reply_edit ) && ( true == $wp_query->bbp_is_reply_edit ) ) return true; return false; } /** * Check if current page is a bbPress user's favorites page (profile page) * * @since bbPress (r2652) * * @uses bbp_get_query_name() To get the query name * @return bool True if it's the favorites page, false if not */ function bbp_is_favorites() { $retval = bbp_is_query_name( 'bbp_user_profile_favorites' ); return apply_filters( 'bbp_is_favorites', (bool) $retval ); } /** * Check if current page is a bbPress user's subscriptions page (profile page) * * @since bbPress (r2652) * * @uses bbp_get_query_name() To get the query name * @return bool True if it's the subscriptions page, false if not */ function bbp_is_subscriptions() { $retval = bbp_is_query_name( 'bbp_user_profile_subscriptions' ); return apply_filters( 'bbp_is_subscriptions', (bool) $retval ); } /** * Check if current page shows the topics created by a bbPress user (profile * page) * * @since bbPress (r2688) * * @uses bbp_get_query_name() To get the query name * @return bool True if it's the topics created page, false if not */ function bbp_is_topics_created() { $retval = bbp_is_query_name( 'bbp_user_profile_topics_created' ); return apply_filters( 'bbp_is_topics_created', (bool) $retval ); } /** * Check if current page is the currently logged in users author page * * @since bbPress (r2688) * * @uses bbPres Checks if bbPress::displayed_user is set and if * bbPress::displayed_user::ID equals bbPress::current_user::ID * or not * @return bool True if it's the user's home, false if not */ function bbp_is_user_home() { global $bbp; if ( empty( $bbp->displayed_user ) ) return false; return (bool) ( (int) $bbp->current_user->ID == (int) $bbp->displayed_user->ID ); } /** * Check if current page is a user profile page * * @since bbPress (r2688) * * @uses WP_Query Checks if WP_Query::bbp_is_single_user is set to true * @return bool True if it's a user's profile page, false if not */ function bbp_is_single_user() { global $wp_query; if ( !empty( $wp_query->bbp_is_single_user ) && ( true == $wp_query->bbp_is_single_user ) ) return true; return false; } /** * Check if current page is a user profile edit page * * @since bbPress (r2688) * * @uses WP_Query Checks if WP_Query::bbp_is_single_user_edit is set to true * @return bool True if it's a user's profile edit page, false if not */ function bbp_is_single_user_edit() { global $wp_query; if ( !empty( $wp_query->bbp_is_single_user_edit ) && ( true == $wp_query->bbp_is_single_user_edit ) ) return true; return false; } /** * Check if current page is a view page * * @since bbPress (r2789) * * @uses WP_Query Checks if WP_Query::bbp_is_view is true * @return bool Is it a view page? */ function bbp_is_single_view() { global $wp_query; if ( !empty( $wp_query->bbp_is_view ) && ( true == $wp_query->bbp_is_view ) ) return true; return false; } /** * Use the above is_() functions to output a body class for each scenario * * @since bbPress (r2926) * * @param array $wp_classes * @param array $custom_classes * @uses bbp_is_forum() * @uses bbp_is_topic() * @uses bbp_is_topic_edit() * @uses bbp_is_topic_merge() * @uses bbp_is_topic_split() * @uses bbp_is_reply() * @uses bbp_is_reply_edit() * @uses bbp_is_reply_edit() * @uses bbp_is_single_view() * @uses bbp_is_single_user_edit() * @uses bbp_is_single_user() * @uses bbp_is_user_home() * @uses bbp_is_subscriptions() * @uses bbp_is_favorites() * @uses bbp_is_topics_created() * @return array Body Classes */ 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'; if ( bbp_is_topic_archive() ) $bbp_classes[] = bbp_get_topic_post_type() . '-archive'; /** Components ************************************************************/ if ( bbp_is_forum() ) $bbp_classes[] = bbp_get_forum_post_type(); if ( bbp_is_topic() ) $bbp_classes[] = bbp_get_topic_post_type(); if ( bbp_is_topic_edit() ) $bbp_classes[] = bbp_get_topic_post_type() . '-edit'; if ( bbp_is_topic_merge() ) $bbp_classes[] = bbp_get_topic_post_type() . '-merge'; if ( bbp_is_topic_split() ) $bbp_classes[] = bbp_get_topic_post_type() . '-split'; if ( bbp_is_reply() ) $bbp_classes[] = bbp_get_reply_post_type(); if ( bbp_is_reply_edit() ) $bbp_classes[] = bbp_get_reply_post_type() . '-edit'; if ( bbp_is_single_view() ) $bbp_classes[] = 'bbp-view'; /** User ******************************************************************/ if ( bbp_is_single_user_edit() ) { $bbp_classes[] = 'bbp-user-edit'; $bbp_classes[] = 'single'; $bbp_classes[] = 'singular'; } if ( bbp_is_single_user() ) { $bbp_classes[] = 'bbp-user-page'; $bbp_classes[] = 'single'; $bbp_classes[] = 'singular'; } if ( bbp_is_user_home() ) { $bbp_classes[] = 'bbp-user-home'; $bbp_classes[] = 'single'; $bbp_classes[] = 'singular'; } if ( bbp_is_topics_created() ) { $bbp_classes[] = 'bbp-topics-created'; $bbp_classes[] = 'single'; $bbp_classes[] = 'singular'; } if ( bbp_is_favorites() ) { $bbp_classes[] = 'bbp-favorites'; $bbp_classes[] = 'single'; $bbp_classes[] = 'singular'; } if ( bbp_is_subscriptions() ) { $bbp_classes[] = 'bbp-subscriptions'; $bbp_classes[] = 'single'; $bbp_classes[] = 'singular'; } /** Clean up **************************************************************/ // Add bbPress class if we are within a bbPress page if ( !empty( $bbp_classes ) ) $bbp_classes[] = 'bbPress'; // Merge WP classes with bbPress classes $classes = array_merge( (array) $bbp_classes, (array) $wp_classes ); // Remove any duplicates $classes = array_unique( $classes ); return apply_filters( 'bbp_get_the_body_class', $classes, $bbp_classes, $wp_classes, $custom_classes ); } /** Forms *********************************************************************/ /** * Output the login form action url * * @since bbPress (r2815) * * @param string $url Pass a URL to redirect to * @uses add_query_arg() To add a arg to the url * @uses site_url() Toget the site url * @uses apply_filters() Calls 'bbp_wp_login_action' with the url and args */ function bbp_wp_login_action( $args = '' ) { $defaults = array ( 'action' => '', 'context' => '' ); $r = wp_parse_args( $args, $defaults ); extract( $r ); if ( !empty( $action ) ) $login_url = add_query_arg( array( 'action' => $action ), 'wp-login.php' ); else $login_url = 'wp-login.php'; $login_url = site_url( $login_url, $context ); echo apply_filters( 'bbp_wp_login_action', $login_url, $args ); } /** * Output hidden request URI field for user forms. * * The referer link is the current Request URI from the server super global. The * input name is '_wp_http_referer', in case you wanted to check manually. * * @since bbPress (r2815) * * @param string $url Pass a URL to redirect to * @uses wp_get_referer() To get the referer * @uses esc_attr() To escape the url * @uses apply_filters() Calls 'bbp_redirect_to_field' with the referer field * and url */ function bbp_redirect_to_field( $redirect_to = '' ) { // Rejig the $redirect_to if ( !isset( $_SERVER['REDIRECT_URL'] ) || ( !$redirect_to = home_url( $_SERVER['REDIRECT_URL'] ) ) ) $redirect_to = wp_get_referer(); // Make sure we are directing somewhere if ( empty( $redirect_to ) ) $redirect_to = home_url( isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '' ); // Remove loggedout query arg if it's there $redirect_to = (string) esc_attr( remove_query_arg( 'loggedout', $redirect_to ) ); $redirect_field = ''; echo apply_filters( 'bbp_redirect_to_field', $redirect_field, $redirect_to ); } /** * Echo sanitized $_REQUEST value. * * Use the $input_type parameter to properly process the value. This * ensures correct sanitization of the value for the receiving input. * * @since bbPress (r2815) * * @param string $request Name of $_REQUEST to look for * @param string $input_type Type of input the value is for * @uses bbp_get_sanitize_val() To sanitize the value */ function bbp_sanitize_val( $request = '', $input_type = 'text' ) { echo bbp_get_sanitize_val( $request, $input_type ); } /** * Return sanitized $_REQUEST value. * * Use the $input_type parameter to properly process the value. This * ensures correct sanitization of the value for the receiving input. * * @since bbPress (r2815) * * @param string $request Name of $_REQUEST to look for * @param string $input_type Type of input the value is for * @uses esc_attr() To escape the string * @uses apply_filters() Calls 'bbp_get_sanitize_val' with the sanitized * value, request and input type * @return string Sanitized value ready for screen display */ function bbp_get_sanitize_val( $request = '', $input_type = 'text' ) { // Check that requested if ( empty( $_REQUEST[$request] ) ) return false; // Set request varaible $pre_ret_val = $_REQUEST[$request]; // Treat different kinds of fields in different ways switch ( $input_type ) { case 'text' : case 'textarea' : $retval = esc_attr( stripslashes( $pre_ret_val ) ); break; case 'password' : case 'select' : case 'radio' : case 'checkbox' : default : $retval = esc_attr( $pre_ret_val ); break; } return apply_filters( 'bbp_get_sanitize_val', $retval, $request, $input_type ); } /** * Output the current tab index of a given form * * Use this function to handle the tab indexing of user facing forms within a * template file. Calling this function will automatically increment the global * tab index by default. * * @since bbPress (r2810) * * @param int $auto_increment Optional. Default true. Set to false to prevent * increment */ function bbp_tab_index( $auto_increment = true ) { echo bbp_get_tab_index( $auto_increment ); } /** * Output the current tab index of a given form * * Use this function to handle the tab indexing of user facing forms * within a template file. Calling this function will automatically * increment the global tab index by default. * * @since bbPress (r2810) * * @uses apply_filters Allows return value to be filtered * @param int $auto_increment Optional. Default true. Set to false to * prevent the increment * @return int $bbp->tab_index The global tab index */ function bbp_get_tab_index( $auto_increment = true ) { global $bbp; if ( true === $auto_increment ) ++$bbp->tab_index; return apply_filters( 'bbp_get_tab_index', (int) $bbp->tab_index ); } /** * Output a select box allowing to pick which forum/topic a new topic/reply * belongs in. * * Can be used for any post type, but is mostly used for topics and forums. * * @since bbPress (r2746) * * @param mixed $args See {@link bbp_get_dropdown()} for arguments */ function bbp_dropdown( $args = '' ) { echo bbp_get_dropdown( $args ); } /** * Output a select box allowing to pick which forum/topic a new * topic/reply belongs in. * * @since bbPress (r2746) * * @param mixed $args The function supports these args: * - post_type: Post type, defaults to bbp_get_forum_post_type() (bbp_forum) * - selected: Selected ID, to not have any value as selected, pass * anything smaller than 0 (due to the nature of select * box, the first value would of course be selected - * though you can have that as none (pass 'show_none' arg)) * - sort_column: Sort by? Defaults to 'menu_order, post_title' * - child_of: Child of. Defaults to 0 * - post_status: Which all post_statuses to find in? Can be an array * or CSV of publish, category, closed, private, spam, * trash (based on post type) - if not set, these are * automatically determined based on the post_type * - posts_per_page: Retrieve all forums/topics. Defaults to -1 to get * all posts * - walker: Which walker to use? Defaults to * {@link BBP_Walker_Dropdown} * - select_id: ID of the select box. Defaults to 'bbp_forum_id' * - tab: Tabindex value. False or integer * - options_only: Show only ? No ' . "\n"; } $retval .= !empty( $show_none ) ? "\t' : ''; $retval .= walk_page_dropdown_tree( $posts, 0, $r ); if ( empty( $options_only ) ) $retval .= ''; // No items found - Display feedback if no custom message was passed } elseif ( empty( $none_found ) ) { // Switch the response based on post type switch ( $post_type ) { // Topics case bbp_get_topic_post_type() : $retval = __( 'No topics available', 'bbpress' ); break; // Forums case bbp_get_forum_post_type() : $retval = __( 'No forums available', 'bbpress' ); break; // Any other default : $retval = __( 'None available', 'bbpress' ); break; } } return apply_filters( 'bbp_get_dropdown', $retval, $args ); } /** * Output the required hidden fields when creating/editing a topic * * @since bbPress (r2753) * * @uses bbp_is_topic_edit() To check if it's the topic edit page * @uses wp_nonce_field() To generate hidden nonce fields * @uses bbp_topic_id() To output the topic id * @uses bbp_is_forum() To check if it's a forum page * @uses bbp_forum_id() To output the forum id */ function bbp_topic_form_fields() { if ( bbp_is_topic_edit() ) : ?> views ) ) return $view; return false; } /** * Output the view name aka title * * @since bbPress (r2789) * * @param string $view Optional. View id * @uses bbp_get_view_title() To get the view title */ function bbp_view_title( $view = '' ) { echo bbp_get_view_title( $view ); } /** * Get the view name aka title * * If a view id is supplied, that is used. Otherwise the bbp_view * query var is checked for. * * @since bbPress (r2789) * * @param string $view Optional. View id * @uses bbp_get_view_id() To get the view id * @return bool|string Title on success, false on failure */ function bbp_get_view_title( $view = '' ) { global $bbp; if ( !$view = bbp_get_view_id( $view ) ) return false; return $bbp->views[$view]['title']; } /** * Output the view url * * @since bbPress (r2789) * * @param string $view Optional. View id * @uses bbp_get_view_url() To get the view url */ function bbp_view_url( $view = false ) { echo bbp_get_view_url( $view ); } /** * Return the view url * * @since bbPress (r2789) * * @param string $view Optional. View id * @uses sanitize_title() To sanitize the view id * @uses home_url() To get blog home url * @uses add_query_arg() To add custom args to the url * @uses apply_filters() Calls 'bbp_get_view_url' with the view url, * used view id * @return string View url (or home url if the view was not found) */ function bbp_get_view_url( $view = false ) { global $bbp, $wp_rewrite; if ( !$view = bbp_get_view_id( $view ) ) return home_url(); // Pretty permalinks if ( $wp_rewrite->using_permalinks() ) { $url = $wp_rewrite->root . $bbp->view_slug . '/' . $view; $url = home_url( user_trailingslashit( $url ) ); // Unpretty permalinks } else { $url = add_query_arg( array( 'bbp_view' => $view ), home_url( '/' ) ); } return apply_filters( 'bbp_get_view_link', $url, $view ); } /** Query *********************************************************************/ /** * Check the passed parameter against the current _bbp_query_name * * @since bbPress (r2980) * * @uses bbp_get_query_name() Get the query var '_bbp_query_name' * @return bool True if match, false if not */ function bbp_is_query_name( $query_name ) { // No empties if ( empty( $query_name ) ) return false; // Check if query var matches if ( bbp_get_query_name() == $query_name ) return true; // No match return false; } /** * Get the '_bbp_query_name' setting * * @since bbPress (r2695) * * @uses get_query_var() To get the query var '_bbp_query_name' * @return string To return the query var value */ function bbp_get_query_name() { return get_query_var( '_bbp_query_name' ); } /** * Set the '_bbp_query_name' setting to $name * * @since bbPress (r2692) * * @param string $name What to set the query var to * @uses set_query_var() To set the query var '_bbp_query_name' */ function bbp_set_query_name( $name = '' ) { set_query_var( '_bbp_query_name', $name ); } /** * Used to clear the '_bbp_query_name' setting * * @since bbPress (r2692) * * @uses bbp_set_query_name() To set the query var '_bbp_query_name' value to '' */ function bbp_reset_query_name() { bbp_set_query_name(); } /** Breadcrumbs ***************************************************************/ /** * Output the page title as a breadcrumb * * @since bbPress (r2589) * * @param string $sep Separator. Defaults to '←' * @param bool $current_page Include the current item * @param bool $root Include the root page if one exists * @uses bbp_get_breadcrumb() To get the breadcrumb */ function bbp_title_breadcrumb( $args = array() ) { echo bbp_get_breadcrumb( $args ); } /** * Output a breadcrumb * * @since bbPress (r2589) * * @param string $sep Separator. Defaults to '←' * @param bool $current_page Include the current item * @param bool $root Include the root page if one exists * @uses bbp_get_breadcrumb() To get the breadcrumb */ function bbp_breadcrumb( $args = array() ) { echo bbp_get_breadcrumb( $args ); } /** * Return a breadcrumb ( forum -> topic -> reply ) * * @since bbPress (r2589) * * @param string $sep Separator. Defaults to '←' * @param bool $current_page Include the current item * @param bool $root Include the root page if one exists * * @uses get_post() To get the post * @uses bbp_get_forum_permalink() To get the forum link * @uses bbp_get_topic_permalink() To get the topic link * @uses bbp_get_reply_permalink() To get the reply link * @uses get_permalink() To get the permalink * @uses bbp_get_forum_post_type() To get the forum post type * @uses bbp_get_topic_post_type() To get the topic post type * @uses bbp_get_reply_post_type() To get the reply post type * @uses bbp_get_forum_title() To get the forum title * @uses bbp_get_topic_title() To get the topic title * @uses bbp_get_reply_title() To get the reply title * @uses get_the_title() To get the title * @uses apply_filters() Calls 'bbp_get_breadcrumb' with the crumbs * @return string Breadcrumbs */ function bbp_get_breadcrumb( $args = array() ) { global $bbp; // Turn off breadcrumbs if ( apply_filters( 'bbp_no_breadcrumb', is_front_page() ) ) return; // Define variables $front_id = $root_id = 0; $ancestors = $breadcrumbs = array(); $pre_root_text = $pre_front_text = $pre_current_text = ''; $pre_include_root = $pre_include_home = $pre_include_current = true; /** Home Text *********************************************************/ // No custom home text if ( empty( $args['home_text'] ) ) { // Set home text to page title if ( $front_id = get_option( 'page_on_front' ) ) { $pre_front_text = get_the_title( $front_id ); // Default to 'Home' } else { $pre_front_text = __( 'Home', 'bbpress' ); } } /** Root Text *********************************************************/ // No custom root text if ( empty( $args['root_text'] ) ) { if ( $page = bbp_get_page_by_path( $bbp->root_slug ) ) { $root_id = $page->ID; } $pre_root_text = bbp_get_forum_archive_title(); } /** Includes **********************************************************/ // Root slug is also the front page if ( !empty( $front_id ) && ( $front_id == $root_id ) ) $pre_include_root = false; // Don't show root if viewing forum archive if ( bbp_is_forum_archive() ) $pre_include_root = false; // Don't show root if viewing page in place of forum archive if ( !empty( $root_id ) && ( ( is_single() || is_page() ) && ( $root_id == get_the_ID() ) ) ) $pre_include_root = false; /** Current Text ******************************************************/ // Forum archive if ( bbp_is_forum_archive() ) $pre_current_text = bbp_get_forum_archive_title(); // Topic archive elseif ( bbp_is_topic_archive() ) $pre_current_text = bbp_get_topic_archive_title(); // View elseif ( bbp_is_single_view() ) $pre_current_text = bbp_get_view_title(); // Single Forum elseif ( bbp_is_forum() ) $pre_current_text = bbp_get_forum_title(); // Single Topic elseif ( bbp_is_topic() ) $pre_current_text = bbp_get_topic_title(); // Single Topic elseif ( bbp_is_reply() ) $pre_current_text = bbp_get_reply_title(); // Topic Tag elseif ( is_tax( $bbp->topic_tag_id ) ) $pre_current_text = sprintf( __( 'Topic Tag: %s', 'bbpress' ), bbp_get_topic_tag_name() ); // Single else $pre_current_text = get_the_title(); /** Parse Args ********************************************************/ // Parse args $defaults = array( // HTML 'before' => '

', 'after' => '

', 'sep' => is_rtl() ? __( '‹', 'bbpress' ) : __( '›', 'bbpress' ), 'pad_sep' => 1, // Home 'include_home' => $pre_include_home, 'home_text' => $pre_front_text, // Forum root 'include_root' => $pre_include_root, 'root_text' => $pre_root_text, // Current 'include_current' => $pre_include_current, 'current_text' => $pre_current_text ); $r = apply_filters( 'bbp_get_breadcrumb_pre', wp_parse_args( $args, $defaults ) ); extract( $r ); /** Ancestors *********************************************************/ // Get post ancestors if ( is_page() || is_single() || bbp_is_topic_edit() || bbp_is_reply_edit() ) $ancestors = array_reverse( get_post_ancestors( get_the_ID() ) ); // Do we want to include a link to home? if ( !empty( $include_home ) || empty( $home_text ) ) $breadcrumbs[] = '' . $home_text . ''; // Do we want to include a link to the forum root? if ( !empty( $include_root ) || empty( $root_text ) ) { // Page exists at root slug path, so use its permalink if ( $page = bbp_get_page_by_path( $bbp->root_slug ) ) { $root_url = get_permalink( $page->ID ); // Use the root slug } else { $root_url = get_post_type_archive_link( bbp_get_forum_post_type() ); } // Add the breadcrumb $breadcrumbs[] = '' . $root_text . ''; } // Ancestors exist if ( !empty( $ancestors ) ) { // Loop through parents foreach( (array) $ancestors as $parent_id ) { // Parents $parent = get_post( $parent_id ); // Switch through post_type to ensure correct filters are applied switch ( $parent->post_type ) { // Forum case bbp_get_forum_post_type() : $breadcrumbs[] = '' . bbp_get_forum_title( $parent->ID ) . ''; break; // Topic case bbp_get_topic_post_type() : $breadcrumbs[] = '' . bbp_get_topic_title( $parent->ID ) . ''; break; // Reply (Note: not in most themes) case bbp_get_reply_post_type() : $breadcrumbs[] = '' . bbp_get_reply_title( $parent->ID ) . ''; break; // WordPress Post/Page/Other default : $breadcrumbs[] = '' . get_the_title( $parent->ID ) . ''; break; } } } /** Current ***********************************************************/ // Add current page to breadcrumb if ( !empty( $include_current ) || empty( $pre_current_text ) ) $breadcrumbs[] = '' . $current_text . ''; /** Finish Up *********************************************************/ // Pad the separator if ( !empty( $pad_sep ) ) $sep = str_pad( $sep, strlen( $sep ) + ( (int) $pad_sep * 2 ), ' ', STR_PAD_BOTH ); // Allow the separator of the breadcrumb to be easily changed $sep = apply_filters( 'bbp_breadcrumb_separator', $sep ); // Right to left support if ( is_rtl() ) $breadcrumbs = apply_filters( 'bbp_breadcrumbs', array_reverse( $breadcrumbs ) ); // Build the trail $trail = !empty( $breadcrumbs ) ? $before . implode( $sep, $breadcrumbs ) . $after: ''; return apply_filters( 'bbp_get_breadcrumb', $trail, $breadcrumbs, $r ); } /** Topic Tags ***************************************************************/ /** * Output all of the allowed tags in HTML format with attributes. * * This is useful for displaying in the post area, which elements and * attributes are supported. As well as any plugins which want to display it. * * @since bbPress (r2780) * * @uses bbp_get_allowed_tags() */ function bbp_allowed_tags() { echo bbp_get_allowed_tags(); } /** * Display all of the allowed tags in HTML format with attributes. * * This is useful for displaying in the post area, which elements and * attributes are supported. As well as any plugins which want to display it. * * @since bbPress (r2780) * * @uses allowed_tags() To get the allowed tags * @uses apply_filters() Calls 'bbp_allowed_tags' with the tags * @return string HTML allowed tags entity encoded. */ function bbp_get_allowed_tags() { return apply_filters( 'bbp_get_allowed_tags', allowed_tags() ); } /** Errors & Messages *********************************************************/ /** * Display possible errors & messages inside a template file * * @since bbPress (r2688) * * @uses WP_Error bbPress::errors::get_error_codes() To get the error codes * @uses WP_Error bbPress::errors::get_error_data() To get the error data * @uses WP_Error bbPress::errors::get_error_messages() To get the error * messages * @uses is_wp_error() To check if it's a {@link WP_Error} */ function bbp_template_notices() { global $bbp; // Bail if no notices or errors if ( !isset( $bbp->errors ) || !is_wp_error( $bbp->errors ) || !$bbp->errors->get_error_codes() ) return; // Define local variable(s) $errors = $messages = array(); // Loop through notices foreach ( $bbp->errors->get_error_codes() as $code ) { // Get notice severity $severity = $bbp->errors->get_error_data( $code ); // Loop through notices and separate errors from messages foreach ( $bbp->errors->get_error_messages( $code ) as $error ) { if ( 'message' == $severity ) { $messages[] = $error; } else { $errors[] = $error; } } } // Display errors first... if ( !empty( $errors ) ) : ?>

\n

", $errors ); ?>

\n

", $messages ); ?>

' . __( 'Log Out', 'bbpress' ) . '', $redirect_to ); } /** Title *********************************************************************/ /** * Custom page title for bbPress pages * * @since bbPress (r2788) * * @param string $title Optional. The title (not used). * @param string $sep Optional, default is '»'. How to separate the * various items within the page title. * @param string $seplocation Optional. Direction to display title, 'right'. * @uses bbp_is_single_user() To check if it's a user profile page * @uses bbp_is_single_user_edit() To check if it's a user profile edit page * @uses bbp_is_user_home() To check if the profile page is of the current user * @uses get_query_var() To get the user id * @uses get_userdata() To get the user data * @uses bbp_is_forum() To check if it's a forum * @uses bbp_get_forum_title() To get the forum title * @uses bbp_is_topic() To check if it's a topic * @uses bbp_get_topic_title() To get the topic title * @uses bbp_is_reply() To check if it's a reply * @uses bbp_get_reply_title() To get the reply title * @uses is_tax() To check if it's the tag page * @uses get_queried_object() To get the queried object * @uses bbp_is_single_view() To check if it's a view * @uses bbp_get_view_title() To get the view title * @uses apply_filters() Calls 'bbp_raw_title' with the title * @uses apply_filters() Calls 'bbp_profile_page_wp_title' with the title, * separator and separator location * @return string The tite */ function bbp_title( $title = '', $sep = '»', $seplocation = '' ) { global $bbp; // Store original title to compare $_title = $title; /** Archives **************************************************************/ // Forum Archive if ( bbp_is_forum_archive() ) { $title = bbp_get_forum_archive_title(); // Topic Archive } elseif ( bbp_is_topic_archive() ) { $title = bbp_get_topic_archive_title(); /** Singles ***************************************************************/ // Forum page } elseif ( bbp_is_forum() ) { $title = sprintf( __( 'Forum: %s', 'bbpress' ), bbp_get_forum_title() ); // Topic page } elseif ( bbp_is_topic() ) { $title = sprintf( __( 'Topic: %s', 'bbpress' ), bbp_get_topic_title() ); // Replies } elseif ( bbp_is_reply() ) { $title = bbp_get_reply_title(); // Topic tag page } elseif ( is_tax( $bbp->topic_tag_id ) ) { $term = get_queried_object(); $title = sprintf( __( 'Topic Tag: %s', 'bbpress' ), $term->name ); /** Users *****************************************************************/ // Profile page } elseif ( bbp_is_single_user() ) { // Current users profile if ( bbp_is_user_home() ) { $title = __( 'Your Profile', 'bbpress' ); // Other users profile } else { $userdata = get_userdata( get_query_var( 'bbp_user_id' ) ); $title = sprintf( __( '%s\'s Profile', 'bbpress' ), $userdata->display_name ); } // Profile edit page } elseif ( bbp_is_single_user_edit() ) { // Current users profile if ( bbp_is_user_home() ) { $title = __( 'Edit Your Profile', 'bbpress' ); // Other users profile } else { $userdata = get_userdata( get_query_var( 'bbp_user_id' ) ); $title = sprintf( __( 'Edit %s\'s Profile', 'bbpress' ), $userdata->display_name ); } /** Views *****************************************************************/ // Views } elseif ( bbp_is_single_view() ) { $title = sprintf( __( 'View: %s', 'bbpress' ), bbp_get_view_title() ); } // Filter the raw title $title = apply_filters( 'bbp_raw_title', $title, $sep, $seplocation ); // Compare new title with original title if ( $title == $_title ) return $title; // Temporary separator, for accurate flipping, if necessary $t_sep = '%WP_TITILE_SEP%'; $prefix = ''; if ( !empty( $title ) ) $prefix = " $sep "; // sep on right, so reverse the order if ( 'right' == $seplocation ) { $title_array = explode( $t_sep, $title ); $title_array = array_reverse( $title_array ); $title = implode( " $sep ", $title_array ) . $prefix; // sep on left, do not reverse } else { $title_array = explode( $t_sep, $title ); $title = $prefix . implode( " $sep ", $title_array ); } // Filter and return return apply_filters( 'bbp_title', $title, $sep, $seplocation ); } ?> ```