null,
'suffix' => null,
'title' => null,
'home' => __( 'Home', 'astra-addon' ),
'delimiter' => null,
'front_page' => false,
'show_blog' => false,
'echo' => true,
'archive-prefix' => __( 'Archives for ', 'astra-addon' ),
'author-prefix' => __( 'Archives for ', 'astra-addon' ),
'search-prefix' => __( 'You searched for ', 'astra-addon' ),
'404-title' => __( 'Error 404: Page not found', 'astra-addon' ),
)
);
/* Format the title. */
$title = ( ! empty( $args['title'] ) ? '' . $args['title'] . '' : '' );
$delimiter = ( ! empty( $args['delimiter'] ) ) ? "{$args['delimiter']}" : "ยป";
/* Get the items. */
$items = astra_breadcrumb_get_items( $args );
if ( ! empty( $items ) ) {
$breadcrumbs = '';
$breadcrumbs .= '';
$breadcrumbs .= $args['prefix'];
$breadcrumbs .= $title;
$breadcrumbs .= join( " {$delimiter} ", $items );
$breadcrumbs .= $args['suffix'];
$breadcrumbs .= '
';
$breadcrumbs .= '';
$breadcrumbs = apply_filters( 'astra_breadcrumb', $breadcrumbs );
if ( ! $args['echo'] ) {
return $breadcrumbs;
} else {
echo $breadcrumbs; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
}
}
}
/**
* Gets the items for the RDFa Breadcrumb.
*
* @param array $args Mixed arguments for the menu.
* @since 1.0.0
*/
function astra_breadcrumb_get_items( $args ) {
global $wp_query;
$item = array();
$show_on_front = get_option( 'show_on_front' );
/* Link to front page. */
if ( ! is_front_page() ) {
$item[] = '' . $args['home'] . '';
}
/* If woocommerce is installed and we're on a woocommerce page. */
if ( function_exists( 'is_woocommerce' ) && is_woocommerce() ) {
woocommerce_breadcrumb();
return false;
}
/* Front page. */
if ( is_home() && ! ( is_front_page() && is_home() ) ) {
// Blog page.
$id = astra_get_post_id();
$home_page = get_page( $wp_query->get_queried_object_id() );
$item = array_merge( $item, astra_breadcrumb_get_parents( $home_page->post_parent ) );
$item['last'] = '' . get_the_title( $id ) . '';
} elseif ( function_exists( 'is_bbpress' ) && is_bbpress() ) {
$item = array_merge( $item, astra_breadcrumb_get_bbpress_items() );
// If viewing a singular post.
} elseif ( is_singular() ) {
$post = $wp_query->get_queried_object();
$post_id = (int) $wp_query->get_queried_object_id();
$post_type = $post->post_type;
$post_type_object = get_post_type_object( $post_type );
if ( 'post' === $post_type && $args['show_blog'] ) {
$item[] = '' . get_the_title( get_option( 'page_for_posts' ) ) . '';
}
if ( 'page' !== $post_type ) {
/* If there's an archive page, add it. */
if ( function_exists( 'get_post_type_archive_link' ) && ! empty( $post_type_object->has_archive ) ) {
$item[] = '' . $post_type_object->labels->name . '';
}
if ( isset( $args[ "singular_{$post_type}_taxonomy" ] ) && is_taxonomy_hierarchical( $args[ "singular_{$post_type}_taxonomy" ] ) ) {
$terms = wp_get_object_terms( $post_id, $args[ "singular_{$post_type}_taxonomy" ] );
if ( isset( $terms[0] ) ) {
$item = array_merge( $item, astra_breadcrumb_get_term_parents( $terms[0], $args[ "singular_{$post_type}_taxonomy" ] ) );
}
} elseif ( isset( $args[ "singular_{$post_type}_taxonomy" ] ) ) {
$item[] = get_the_term_list( $post_id, $args[ "singular_{$post_type}_taxonomy" ], '', ', ', '' );
}
}
$post_parent = ( isset( $wp_query->post->post_parent ) ) ? $wp_query->post->post_parent : '';
$parents = astra_breadcrumb_get_parents( $post_parent );
if ( ( is_post_type_hierarchical( $wp_query->post->post_type ) || 'attachment' === $wp_query->post->post_type ) && $parents ) {
$item = array_merge( $item, $parents );
}
$item['last'] = '' . get_the_title() . '';
// If viewing any type of archive.
} elseif ( is_archive() ) {
if ( is_category() || is_tag() || is_tax() ) {
$term = $wp_query->get_queried_object();
$taxonomy = get_taxonomy( $term->taxonomy );
$parents = astra_breadcrumb_get_term_parents( $term->parent, $term->taxonomy );
if ( ( is_taxonomy_hierarchical( $term->taxonomy ) && $term->parent ) && $parents ) {
$item = array_merge( $item, $parents );
}
$item['last'] = '' . $term->name . '';
} elseif ( function_exists( 'is_post_type_archive' ) && is_post_type_archive() ) {
$post_type_object = get_post_type_object( get_query_var( 'post_type' ) );
$item['last'] = '' . $post_type_object->labels->name . '';
} elseif ( is_date() ) {
if ( is_day() ) {
$item['last'] = '' . $args['archive-prefix'] . get_the_time( 'F j, Y' ) . '';
} elseif ( is_month() ) {
$item['last'] = '' . $args['archive-prefix'] . single_month_title( ' ', false ) . '';
} elseif ( is_year() ) {
$item['last'] = '' . $args['archive-prefix'] . get_the_time( 'Y' ) . '';
}
} elseif ( is_author() ) {
$item['last'] = '' . $args['author-prefix'] . get_the_author_meta( 'display_name', ( isset( $wp_query->post->post_author ) ) ? $wp_query->post->post_author : '' ) . '';
}
// If viewing search results.
} elseif ( is_search() ) {
$item['last'] = '' . $args['search-prefix'] . stripslashes( wp_strip_all_tags( get_search_query() ) ) . '';
// If viewing a 404 error page.
} elseif ( is_404() ) {
$item['last'] = '' . $args['404-title'] . '';
}
return apply_filters( 'astra_breadcrumb_items', $item );
}
/**
* Gets the items for the breadcrumb item if bbPress is installed.
*
* @since 1.0.0
*
* @param array $args Mixed arguments for the menu.
*
* @return array List of items to be shown in the item.
*/
function astra_breadcrumb_get_bbpress_items( $args = array() ) {
$item = array();
$post_type_object = get_post_type_object( bbp_get_forum_post_type() );
if ( ! empty( $post_type_object->has_archive ) && ! bbp_is_forum_archive() ) {
$item[] = '' . bbp_get_forum_archive_title() . '';
}
if ( bbp_is_forum_archive() ) {
$item[] = bbp_get_forum_archive_title();
} elseif ( bbp_is_topic_archive() ) {
$item[] = bbp_get_topic_archive_title();
} elseif ( bbp_is_single_view() ) {
$item[] = bbp_get_view_title();
} elseif ( bbp_is_single_topic() ) {
$topic_id = get_queried_object_id();
$item = array_merge( $item, astra_breadcrumb_get_parents( bbp_get_topic_forum_id( $topic_id ) ) );
if ( bbp_is_topic_split() || bbp_is_topic_merge() || bbp_is_topic_edit() ) {
$item[] = '' . bbp_get_topic_title( $topic_id ) . '';
}
if ( bbp_is_topic_split() ) {
$item[] = __( 'Split', 'astra-addon' );
} elseif ( bbp_is_topic_merge() ) {
$item[] = __( 'Merge', 'astra-addon' );
} elseif ( bbp_is_topic_edit() ) {
$item[] = __( 'Edit', 'astra-addon' );
}
} elseif ( bbp_is_single_reply() ) {
$reply_id = get_queried_object_id();
$item = array_merge( $item, astra_breadcrumb_get_parents( bbp_get_reply_topic_id( $reply_id ) ) );
if ( ! bbp_is_reply_edit() ) {
$item[] = bbp_get_reply_title( $reply_id );
} else {
$item[] = '' . bbp_get_reply_title( $reply_id ) . '';
$item[] = __( 'Edit', 'astra-addon' );
}
} elseif ( bbp_is_single_forum() ) {
$forum_id = get_queried_object_id();
$forum_parent_id = bbp_get_forum_parent( $forum_id );
if ( 0 !== $forum_parent_id ) {
$item = array_merge( $item, astra_breadcrumb_get_parents( $forum_parent_id ) );
}
$item[] = bbp_get_forum_title( $forum_id );
} elseif ( bbp_is_single_user() || bbp_is_single_user_edit() ) {
if ( bbp_is_single_user_edit() ) {
$item[] = '' . bbp_get_displayed_user_field( 'display_name' ) . '';
$item[] = __( 'Edit', 'astra-addon' );
} else {
$item[] = bbp_get_displayed_user_field( 'display_name' );
}
}
return apply_filters( 'astra_breadcrumb_get_bbpress_items', $item, $args );
}
/**
* Gets parent pages of any post type.
*
* @since 1.0.0
*
* @param int $post_id ID of the post whose parents we want.
* @param string $delimiter .
*
* @return string $html String of parent page links.
*/
function astra_breadcrumb_get_parents( $post_id = '', $delimiter = '/' ) {
$parents = array();
if ( 0 == $post_id ) {
return $parents;
}
while ( $post_id ) {
$page = get_page( $post_id );
$parents[] = '' . get_the_title( $post_id ) . '';
$post_id = $page->post_parent;
}
if ( $parents ) {
$parents = array_reverse( $parents );
}
return $parents;
}
/**
* Searches for term parents of hierarchical taxonomies.
*
* @since 1.0.0
*
* @param int $parent_id The ID of the first parent.
* @param object|string $taxonomy The taxonomy of the term whose parents we want.
* @param string $delimiter The separator.
*
* @return string $html String of links to parent terms.
*/
function astra_breadcrumb_get_term_parents( $parent_id = '', $taxonomy = '', $delimiter = '/' ) {
$html = array();
$parents = array();
if ( empty( $parent_id ) || empty( $taxonomy ) ) {
return $parents;
}
while ( $parent_id ) {
$parent = get_term( $parent_id, $taxonomy );
$parents[] = '' . $parent->name . '';
$parent_id = $parent->parent;
}
if ( $parents ) {
$parents = array_reverse( $parents );
}
return $parents;
}
}