Breadcrumb NavXT

Breadcrumb NavXT, the successor to the popular WordPress plugin Breadcrumb Navigation XT, was written from the ground up to be better than its ancestor.

Table of Contents

1. Purpose
2. Download
3. Installation
4. Basic Usage
5. Advanced Usage
6. Version History and Changelog
7. License

Purpose

Breadcrumb NavXT is a WordPress plugin compatible with WordPress versions 3.0 and up. This plugin generates locational breadcrumb trails for your WordPress blog. These represent the hierarchy leading up to the current page rather than the actual path taken to arrive at the current page.

Breadcrumb trails are a good supplementary navigation system that aid in site usability. This is especially true for sites using WordPress as a CMS. Since Breadcrumb NavXT reveals the page hierarchy in a consistent manner, it can provide SEO benefits. On the right are examples of breadcrumb trails generated by Breadcrumb NavXT. This website runs Breadcrumb NavXT, browse the various sections to see how Breadcrumb NavXT behaves.

Download

Latest Stable Release: Breadcrumb NavXT 3.6.0

Latest Testing Release: Breadcrumb NavXT SVN Trunk

Installation

1. Download the plugin zip archive, see Download section.
2. Disable any previous version of this plugin or Breadcrumb Navigation XT.
3. Extract the contents of the zip archive into your plugins folder (wp-content/plugins).
4. Enable the Breadcrumb NavXT plugin in the administration panel under the Plugins > Installed section.
5. Continue onto the Basic Usage section, or follow instructions given by your theme (if applicable).

Basic Usage

Depending on your theme this section may be unnecessary. If you are using berry as your theme everything is done for you so you have no further steps to take. If you are a theme developer visit the documentation for examples on how to directly access the bcn_breadcrumb_trail class. Otherwise keep reading.

Open the appropriate file for your theme (typically header.php). This can be done within WordPress’ administration panel through Presentation > Theme Editor or through your favorite text editor. Place the following code where you want the breadcrumb trail to appear.

<div class="breadcrumb">
<?php
if(function_exists('bcn_display'))
{
	bcn_display();
}
?>
</div>

Save the file (upload if applicable). Now you should have a breadcrumb trail on your WordPress powered site. To customize the breadcrumb trail you may edit the default values for the options in the administrative interface. This is located in your administration panel under Settings > Breadcrumb NavXT.

Advanced Usage

Examples on some advanced usage situations are available in the documentation.

Version History and Changelog

• 3.7.0 [11-??-2010]:
  New feature: Can use any hierarchical post type as a hierarchy for flat post types.
  New feature: Users are now warned if settings are out of date, allowed to do a one click settings migration.
  New feature: Users can now control if a post type uses the “posts page” in it’s hierarchy or not.
  Bug fix: Users can now set custom post types to have a page hierarchy through the settings page.
  Bug fix: Fixed issues where the PHP version check did not work correctly.
  Bug fix: Fixed issue where all settings would get reset on “clean” 3.6.0 installs on plugin activation.
• 3.6.0 [8-23-2010]:
  New feature: Vastly improved support for WordPress custom post types.
  New feature: Can now restrict breadcrumb trail output for the front page in the included Widget.
  New feature: Can now undo setting saves, resets, and imports.
  New feature: Translations for Japanese now included thanks to Kazuhiro Terada.
  Bug fix: Fixed issue where the class element were not closed in a li opening tag.
  Bug fix: Safer handling of blank anchor templates.
  Bug fix: Fixed issue where the %title% tag in the current item anchor template would be trimmed.
• 3.5.1 [6-3-2010]:
  Bug fix: Fixed issue where a deactivation/activation cycle would reset all of the user specified settings.
  Bug fix: Fixed issue where the archive by date suffix field did not save.
  Bug fix: Fixed issue where custom taxonomy settings did not save.
  Bug fix: Fixed issue where xml settings files would not import.
  Bug fix: French and German translations updated for 3.5.x.
• 3.5.0 [5-25-2010]:
  New feature: Added actions bcn_before_fill and bcn_after_fill, see documentation for more information.
  New feature: Widget rewritten to use the WordPress 2.8 Widget API, now multi-widget capable.
  New feature: Widget output can be in list form, can be in reversed order, and can be unlinked.
  Bug fix: Fixed issue where the current tab was forgotten after a save in the settings page.
  Bug fix: Fixed various WP API issues with WordPress 3.0.
  Bug fix: Fixed title trimming so that it works properly with multi-byte characters.
• 3.4.1 [12-23-2009]:
  Bug fix: Fixed issue with PHP unexpected $end on line 1567 in breadcrumb_navxt_admin.php.
  Bug fix: Fixed issue where the %link% anchor tag would not be replaced with a URI for flat taxonomies (e.g. tags).
  Bug fix: Fixed issue where paged breadcrumbs would cause WP_Error objects to be thrown.
• 3.4.0 [12-17-2009]:
  New feature: Proper support of custom taxonomies. category_parents() and post_tags() replaced with term_parents() and post_terms().
  New feature: Ability to use date as post “taxonomy”.
  New feature: Translations for Italian now included thanks to Luca Camellini.
  Bug fix: Fixed permalink for day breadcrumbs.
  Bug fix: Flat taxonomy archive breadcrumbs now are surrounded by both the standard and archive prefix/suffix combination.
• 3.3.0 [8-3-2009]:
  Behavior change: The core plugin was removed, and administrative plugin renamed, direct class access still possible.
  New feature: Ability to trim the title length for all breadcrumbs in the trail.
  New feature: Ability to selectively include the “Blog” in addition to the “Home” breadcrumb in the trail (for static front page setups).
  New feature: Translations for Russian now included thanks to Yuri Gribov.
  New feature: Translations for Swedish now included thanks to Patrik Spathon.
  Bug fix: Minor tweaks to the settings link in the plugins listing page so that it fits better in WordPress 2.8.
  Bug fix: Now selects the first category hierarchy of a post instead of the last.
• 3.2.1 [5-29-2009]:
  New feature: Translations for Belorussian now included thanks to “Fat Cow”.
  Bug fix: The bcn_display() and bcn_display_list() wrapper functions obey the
  $return parameter.
  Bug fix: Anchors now will be valid html even when a page/category/post title has html tags in it.
  Bug fix: Revised bcn_breadcrumb_trail::category_parents to work around a bug in get_category that causes a WP_Error to be thrown.
  Bug fix: Importing settings XML files should no longer corrupt html entities.
  Bug fix: Can no longer import and reset options at the same time.
  Bug fix: WordPress 2.6 should be supported again.
• 3.2.0 [5-4-2009]:
  New feature: Now can output breadcrumbs in trail as list elements.
  New feature: Translations for Dutch now included thanks to Stan Lenssen.
  New feature: Now breadcrumb trails can be output in reverse order.
  New feature: Ability to reset to default option values in administrative interface.
  New feature: Ability to export settings to a XML file.
  New feature: Ability to import settings from a XML file.
  Bug fix: Anchor templates now protected against complete clearing.
  Bug fix: Administrative interface related styling and JavaScript no longer leaks to other admin pages.
  Bug fix: Calling bcn_display() works with the same inputs as bcn_breadcrumb_trail::display().
  Bug fix: Calling bcn_display() multiple times will not place duplicate breadcrumbs into the trail.
• 3.1.0 [1-26-2009]:
  New feature: Tabular plugin integrated into the administrative interface/settings page plugin.
  New feature: Default options now are localized.
  New feature: Plugin uninstaller following the WordPress plugin uninstaller API.
  Bug fix: Administrative interface tweaked, hopefully more usable.
  Bug fix: Tabs work with WordPress 2.8-bleeding-edge.
  Bug fix: Translations for German, French, and Spanish are all updated.
  Bug fix: Paged archives, searches, and frontpage fixed.
• 3.0.2 [11-26-2008]:
  Bug fix: Default options are installed correctly now for most users.
  Bug fix: Now bcn_breadcrumb_trail::fill() is safe to call within the loop.
  Bug fix: In WPMU options now are properly separate/independent for each blog.
  Bug fix: WPMU settings page loads correctly after saving settings.
  Bug fix: Blog_anchor setting not lost on non-static frontpage blogs.
  Bug fix: Tabular add on no longer causes issues with WordPress 2.7.
  New feature: Spanish and French localization files are now included thanks to Karin Sequen and Laurent Grabielle.
• 3.0.1 [10-22-2008]:
  Bug fix: UTF-8 characters in the administrative interface now save/display correctly.
  Bug fix: Breadcrumb trails for attachments of pages no longer generate PHP errors.
  Bug fix: Administrative interface tweaks for installing default options.
  Bug fix: Changed handling of situation when Posts Page is not set and Front Page is set.
• 3.0.0 [9-22-2008]:
  New feature: Completely rewritten core and administrative interface.
  New feature: WordPress sidebar widget built in.
  New feature: Breadcrumb trail can output without links.
  New feature: Customizable anchor templates, allows things such as rel=”nofollow”.
  New feature: The home breadcrumb may now be excluded from the breadcrumb trail.
  Bug fix: 404 page breadcrumbs show up in static frontpage situations where the posts page is a child of the home page.
  Bug fix: Static frontpage situations involving the posts page being more than one level off of the home behave as expected.
  Bug fix: Compatible with all polyglot like plugins.
  Bug fix: Compatible with Viper007bond’s Breadcrumb Titles for Pages plugin (but 3.0.0 can replace it as well)
  Bug fix: Author page support should be fixed on some setups where it did not work before.

To keep this page at a reasonable length, only the 3.x.x branch versions are present in this changelog. For the entire changelog, including versions of Breadcrumb Navigation XT, visit the Breadcrumb NavXT Changelog page.

License

Breadcrumb NavXT is released under the GNU GPL 2.0 license and comes with absolutely no warranty. By downloading Breadcrumb NavXT you agree to the terms of the GNU GPL 2.0 license.