breadcrumb_trail() template tag to use anywhere in your theme to show a breadcrumb menu. * Version: 0.3.2 * Author: Justin Tadlock * Author URI: http://justintadlock.com * * Breadcrumb Trail - A breadcrumb menu script for WordPress. * * Breadcrumb Trail is a script for showing a breadcrumb trail for any type of page. It tries to anticipate * any type of structure and display the best possible trail that matches your site's permalink structure. * While not perfect, it attempts to fill in the gaps left by many other breadcrumb scripts. * * This program is free software; you can redistribute it and/or modify it under the terms of the GNU * General Public License version 2, as published by the Free Software Foundation. You may NOT assume * that you can use any other version of the GPL. * * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. * * @package BreadcrumbTrail * @version 0.3.2 * @author Justin Tadlock * @copyright Copyright (c) 2008 - 2010, Justin Tadlock * @link http://justintadlock.com/archives/2009/04/05/breadcrumb-trail-wordpress-plugin * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html */ /** * Yes, we're localizing the plugin. This partly makes sure non-English * users can use it too. To translate into your language use the * en_EN.po file as as guide. Poedit is a good tool to for translating. * @link http://poedit.net * * @since 0.1 */ load_plugin_textdomain( 'breadcrumb-trail', false, 'breadcrumb-trail' ); /** * Shows a breadcrumb for all types of pages. Themes and plugins can filter $args or input directly. * Allow filtering of only the $args using get_the_breadcrumb_args. * * @since 0.1 * @param array $args Mixed arguments for the menu. * @return string Output of the breadcrumb menu. */ function breadcrumb_trail( $args = array() ) { global $wp_query, $wp_rewrite; /* Get the textdomain. */ $textdomain = 'breadcrumb-trail'; /* Create an empty variable for the breadcrumb. */ $breadcrumb = ''; /* Create an empty array for the trail. */ $trail = array(); $path = ''; /* Set up the default arguments for the breadcrumb. */ $defaults = array( 'separator' => '/', 'before' => '' . __( 'Browse:', $textdomain ) . '', 'after' => false, 'front_page' => true, 'show_home' => __( 'Home', $textdomain ), 'single_tax' => null, // @deprecated 0.3 Use singular_{$post_type}_taxonomy. 'echo' => true ); /* Allow singular post views to have a taxonomy's terms prefixing the trail. */ if ( is_singular() ) $defaults["singular_{$wp_query->post->post_type}_taxonomy"] = false; /* Apply filters to the arguments. */ $args = apply_filters( 'breadcrumb_trail_args', $args ); /* Parse the arguments and extract them for easy variable naming. */ extract( wp_parse_args( $args, $defaults ) ); /* For backwards compatibility, set $single_tax if it's explicitly given. */ if ( !is_null( $single_tax ) ) $args['singular_post_taxonomy'] = $single_tax; /* If $show_home is set and we're not on the front page of the site, link to the home page. */ if ( !is_front_page() && $show_home ) $trail[] = '' . $show_home . ''; /* If viewing the front page of the site. */ if ( is_front_page() ) { if ( !$front_page ) $trail = false; elseif ( $show_home ) $trail['trail_end'] = "{$show_home}"; } /* If viewing the "home"/posts page. */ elseif ( is_home() ) { $home_page = get_page( $wp_query->get_queried_object_id() ); $trail = array_merge( $trail, breadcrumb_trail_get_parents( $home_page->post_parent, '' ) ); $trail['trail_end'] = get_the_title( $home_page->ID ); } /* If viewing a singular post (page, attachment, etc.). */ elseif ( is_singular() ) { /* Get singular post variables needed. */ $post = $wp_query->get_queried_object(); $post_id = absint( $wp_query->get_queried_object_id() ); $post_type = $post->post_type; $parent = $post->post_parent; /* If a custom post type, check if there are any pages in its hierarchy based on the slug. */ if ( 'page' !== $post_type ) { $post_type_object = get_post_type_object( $post_type ); /* If $front has been set, add it to the $path. */ if ( 'post' == $post_type || 'attachment' == $post_type || ( $post_type_object->rewrite['with_front'] && $wp_rewrite->front ) ) $path .= trailingslashit( $wp_rewrite->front ); /* If there's a slug, add it to the $path. */ if ( !empty( $post_type_object->rewrite['slug'] ) ) $path .= $post_type_object->rewrite['slug']; /* If there's a path, check for parents. */ if ( !empty( $path ) ) $trail = array_merge( $trail, breadcrumb_trail_get_parents( '', $path ) ); /* If there's an archive page, add it to the trail. */ if ( !empty( $post_type_object->rewrite['archive'] ) && function_exists( 'get_post_type_archive_link' ) ) $trail[] = '' . $post_type_object->labels->name . ''; } /* If the post type path returns nothing and there is a parent, get its parents. */ if ( empty( $path ) && 0 !== $parent || 'attachment' == $post_type ) $trail = array_merge( $trail, breadcrumb_trail_get_parents( $parent, '' ) ); /* Display terms for specific post type taxonomy if requested. */ if ( isset( $args["singular_{$post_type}_taxonomy"] ) && $terms = get_the_term_list( $post_id, $args["singular_{$post_type}_taxonomy"], '', ', ', '' ) ) $trail[] = $terms; /* End with the post title. */ $post_title = get_the_title(); if ( !empty( $post_title ) ) $trail['trail_end'] = $post_title; } /* If we're viewing any type of archive. */ elseif ( is_archive() ) { /* If viewing a taxonomy term archive. */ if ( is_tax() || is_category() || is_tag() ) { /* Get some taxonomy and term variables. */ $term = $wp_query->get_queried_object(); $taxonomy = get_taxonomy( $term->taxonomy ); /* Get the path to the term archive. Use this to determine if a page is present with it. */ if ( is_category() ) $path = get_option( 'category_base' ); elseif ( is_tag() ) $path = get_option( 'tag_base' ); else { if ( $taxonomy->rewrite['with_front'] && $wp_rewrite->front ) $path = trailingslashit( $wp_rewrite->front ); $path .= $taxonomy->rewrite['slug']; } /* Get parent pages by path if they exist. */ if ( $path ) $trail = array_merge( $trail, breadcrumb_trail_get_parents( '', $path ) ); /* If the taxonomy is hierarchical, list its parent terms. */ if ( is_taxonomy_hierarchical( $term->taxonomy ) && $term->parent ) $trail = array_merge( $trail, breadcrumb_trail_get_term_parents( $term->parent, $term->taxonomy ) ); /* Add the term name to the trail end. */ $trail['trail_end'] = $term->name; } /* If viewing a post type archive. */ elseif ( function_exists( 'is_post_type_archive' ) && is_post_type_archive() ) { /* Get the post type object. */ $post_type_object = get_post_type_object( get_query_var( 'post_type' ) ); /* If $front has been set, add it to the $path. */ if ( $post_type_object->rewrite['with_front'] && $wp_rewrite->front ) $path .= trailingslashit( $wp_rewrite->front ); /* If there's a slug, add it to the $path. */ if ( !empty( $post_type_object->rewrite['archive'] ) ) $path .= $post_type_object->rewrite['archive']; /* If there's a path, check for parents. */ if ( !empty( $path ) ) $trail = array_merge( $trail, breadcrumb_trail_get_parents( '', $path ) ); /* Add the post type [plural] name to the trail end. */ $trail['trail_end'] = $post_type_object->labels->name; } /* If viewing an author archive. */ elseif ( is_author() ) { /* If $front has been set, add it to $path. */ if ( !empty( $wp_rewrite->front ) ) $path .= trailingslashit( $wp_rewrite->front ); /* If an $author_base exists, add it to $path. */ if ( !empty( $wp_rewrite->author_base ) ) $path .= $wp_rewrite->author_base; /* If $path exists, check for parent pages. */ if ( !empty( $path ) ) $trail = array_merge( $trail, breadcrumb_trail_get_parents( '', $path ) ); /* Add the author's display name to the trail end. */ $trail['trail_end'] = get_the_author_meta( 'display_name', get_query_var( 'author' ) ); } /* If viewing a time-based archive. */ elseif ( is_time() ) { if ( get_query_var( 'minute' ) && get_query_var( 'hour' ) ) $trail['trail_end'] = get_the_time( __( 'g:i a', $textdomain ) ); elseif ( get_query_var( 'minute' ) ) $trail['trail_end'] = sprintf( __( 'Minute %1$s', $textdomain ), get_the_time( __( 'i', $textdomain ) ) ); elseif ( get_query_var( 'hour' ) ) $trail['trail_end'] = get_the_time( __( 'g a', $textdomain ) ); } /* If viewing a date-based archive. */ elseif ( is_date() ) { /* If $front has been set, check for parent pages. */ if ( $wp_rewrite->front ) $trail = array_merge( $trail, breadcrumb_trail_get_parents( '', $wp_rewrite->front ) ); if ( is_day() ) { $trail[] = '' . get_the_time( __( 'Y', $textdomain ) ) . ''; $trail[] = '' . get_the_time( __( 'F', $textdomain ) ) . ''; $trail['trail_end'] = get_the_time( __( 'j', $textdomain ) ); } elseif ( get_query_var( 'w' ) ) { $trail[] = '' . get_the_time( __( 'Y', $textdomain ) ) . ''; $trail['trail_end'] = sprintf( __( 'Week %1$s', $textdomain ), get_the_time( esc_attr__( 'W', $textdomain ) ) ); } elseif ( is_month() ) { $trail[] = '' . get_the_time( __( 'Y', $textdomain ) ) . ''; $trail['trail_end'] = get_the_time( __( 'F', $textdomain ) ); } elseif ( is_year() ) { $trail['trail_end'] = get_the_time( __( 'Y', $textdomain ) ); } } } /* If viewing search results. */ elseif ( is_search() ) $trail['trail_end'] = sprintf( __( 'Search results for "%1$s"', $textdomain ), esc_attr( get_search_query() ) ); /* If viewing a 404 error page. */ elseif ( is_404() ) $trail['trail_end'] = __( '404 Not Found', $textdomain ); /* Connect the breadcrumb trail if there are items in the trail. */ if ( is_array( $trail ) ) { /* Open the breadcrumb trail containers. */ $breadcrumb = '
'; /* If $before was set, wrap it in a container. */ if ( !empty( $before ) ) $breadcrumb .= '' . $before . ' '; /* Wrap the $trail['trail_end'] value in a container. */ if ( !empty( $trail['trail_end'] ) ) $trail['trail_end'] = '' . $trail['trail_end'] . ''; /* Format the separator. */ if ( !empty( $separator ) ) $separator = '' . $separator . ''; /* Join the individual trail items into a single string. */ $breadcrumb .= join( " {$separator} ", $trail ); /* If $after was set, wrap it in a container. */ if ( !empty( $after ) ) $breadcrumb .= ' ' . $after . ''; /* Close the breadcrumb trail containers. */ $breadcrumb .= '
'; } /* Allow developers to filter the breadcrumb trail HTML. */ $breadcrumb = apply_filters( 'breadcrumb_trail', $breadcrumb ); /* Output the breadcrumb. */ if ( $echo ) echo $breadcrumb; else return $breadcrumb; } /** * Gets parent pages of any post type or taxonomy by the ID or Path. The goal of this function is to create * a clear path back to home given what would normally be a "ghost" directory. If any page matches the given * path, it'll be added. But, it's also just a way to check for a hierarchy with hierarchical post types. * * @since 0.3 * @param int $post_id ID of the post whose parents we want. * @param string $path Path of a potential parent page. * @return array $trail Array of parent page links. */ function breadcrumb_trail_get_parents( $post_id = '', $path = '' ) { /* Set up an empty trail array. */ $trail = array(); /* If neither a post ID nor path set, return an empty array. */ if ( empty( $post_id ) && empty( $path ) ) return $trail; /* If the post ID is empty, use the path to get the ID. */ if ( empty( $post_id ) ) { /* Get parent post by the path. */ $parent_page = get_page_by_path( $path ); /* If a parent post is found, set the $post_id variable to it. */ if ( !empty( $parent_page ) ) $post_id = $parent_page->ID; } /* If a post ID and path is set, search for a post by the given path. */ if ( $post_id == 0 && !empty( $path ) ) { /* Separate post names into separate paths by '/'. */ $path = trim( $path, '/' ); preg_match_all( "/\/.*?\z/", $path, $matches ); /* If matches are found for the path. */ if ( isset( $matches ) ) { /* Reverse the array of matches to search for posts in the proper order. */ $matches = array_reverse( $matches ); /* Loop through each of the path matches. */ foreach ( $matches as $match ) { /* If a match is found. */ if ( isset( $match[0] ) ) { /* Get the parent post by the given path. */ $path = str_replace( $match[0], '', $path ); $parent_page = get_page_by_path( trim( $path, '/' ) ); /* If a parent post is found, set the $post_id and break out of the loop. */ if ( !empty( $parent_page ) && $parent_page->ID > 0 ) { $post_id = $parent_page->ID; break; } } } } } /* While there's a post ID, add the post link to the $parents array. */ while ( $post_id ) { /* Get the post by ID. */ $page = get_page( $post_id ); /* Add the formatted post link to the array of parents. */ $parents[] = '' . get_the_title( $post_id ) . ''; /* Set the parent post's parent to the post ID. */ $post_id = $page->post_parent; } /* If we have parent posts, reverse the array to put them in the proper order for the trail. */ if ( isset( $parents ) ) $trail = array_reverse( $parents ); /* Return the trail of parent posts. */ return $trail; } /** * Searches for term parents of hierarchical taxonomies. This function is similar to the WordPress * function get_category_parents() but handles any type of taxonomy. * * @since 0.3 * @param int $parent_id The ID of the first parent. * @param object|string $taxonomy The taxonomy of the term whose parents we want. * @return array $trail Array of links to parent terms. */ function breadcrumb_trail_get_term_parents( $parent_id = '', $taxonomy = '' ) { /* Set up some default arrays. */ $trail = array(); $parents = array(); /* If no term parent ID or taxonomy is given, return an empty array. */ if ( empty( $parent_id ) || empty( $taxonomy ) ) return $trail; /* While there is a parent ID, add the parent term link to the $parents array. */ while ( $parent_id ) { /* Get the parent term. */ $parent = get_term( $parent_id, $taxonomy ); /* Add the formatted term link to the array of parent terms. */ $parents[] = '' . $parent->name . ''; /* Set the parent term's parent as the parent ID. */ $parent_id = $parent->parent; } /* If we have parent terms, reverse the array to put them in the proper order for the trail. */ if ( !empty( $parents ) ) $trail = array_reverse( $parents ); /* Return the trail of parent terms. */ return $trail; } ?>