bb_get_forum_bread_crumb
The BuddyPress bb get forum bread crumb function.
Description
bb_get_forum_bread_crumb( (string) $args = '' );
Parameters (1)
- 0. $args — Optional. (string) =>
''
- The args.
Usage
if ( !function_exists( 'bb_get_forum_bread_crumb' ) ) { require_once ABSPATH . PLUGINDIR . 'buddypress/bp-forums/bbpress/bb-includes/functions.bb-template.php'; } // The args. $args = ''; // NOTICE! Understand what this does before running. $result = bb_get_forum_bread_crumb($args);
Defined (1)
The function is defined in the following location(s).
- /bp-forums/bbpress/bb-includes/functions.bb-template.php
- function bb_get_forum_bread_crumb($args = '') {
- $defaults = array(
- 'forum_id' => 0,
- 'separator' => ' » ',
- 'class' => null
- );
- $args = wp_parse_args($args, $defaults);
- extract($args, EXTR_SKIP);
- $trail = '';
- $trail_forum = bb_get_forum(get_forum_id($forum_id));
- if ($class) {
- $class = ' class="' . $class . '"';
- }
- $current_trail_forum_id = $trail_forum->forum_id;
- while ( $trail_forum && $trail_forum->forum_id > 0 ) {
- $crumb = $separator;
- if ($current_trail_forum_id != $trail_forum->forum_id || !bb_is_forum()) {
- $crumb .= '<a' . $class . ' href="' . get_forum_link($trail_forum->forum_id) . '">';
- } elseif ($class) {
- $crumb .= '<span' . $class . '>';
- }
- $crumb .= get_forum_name($trail_forum->forum_id);
- if ($current_trail_forum_id != $trail_forum->forum_id || !bb_is_forum()) {
- $crumb .= '</a>';
- } elseif ($class) {
- $crumb .= '</span>';
- }
- $trail = $crumb . $trail;
- $trail_forum = bb_get_forum($trail_forum->forum_parent);
- }
- return apply_filters('bb_get_forum_bread_crumb', $trail, $forum_id );
- }