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. Donate
7. Version History and Changelog
8. License

Purpose

Breadcrumb NavXT is a WordPress plugin compatible with WordPress versions 3.2 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 4.3.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.

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="breadcrumbs">
	<?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.

Donate

Love Breadcrumb NavXT? Want to help development? Feel free to make a donation:

Translators

• Russian by Alexander Samsonov
• Hungarian by Atis Papai
• Malay by Ben Di
• German by Daniel Lang
• Arabic by Eid Aldikanji of devnet - نحو محتوى تقني عربي أغنى
• French (France) by Emmanuel Beziat
• Turkish by Hakan Er
• Czech by jakubmachala
• Norwegian (Bokmål) by Jan Rosvoldsve
• Danish by Joachim Jensen of Intox Studio
• Spanish (Spain) by Karin Sequen
• Polish by Klaudia Tyczyńska
• Hindi by Love Chandel of Outshine Solutions
• Portuguese (Portugal) by Luís Rodrigues
• Estonian by Martin Orn
• Latvian by Martins Dzerve
• Swedish by Patrik Spathon
• Italian by Tamara Balestri
• Finnish by Ville Pilvio
• Azerbaijani by Zaur Bayramov

Version History and Changelog

• 4.3.0 [2-13-2013]:
  Behaviour change: Home and Mainsite titles were removed.
  Behaviour change: All HTML capable strings are now passed through wp_kses.
  New feature: Added bcn_breadcrumb_url filter.
  New feature: %title% and %htitle% now are replaced with the the “Site Title” for the home breadcrumb and the “Network Name” for mainsite breadcrumbs.
  New feature: Support for the proposed Theme Hook Alliance tha_breadcrumb_navigation filter.
  New feature: Added %ftitle% and %fhtitle% tags that are not affected by bcn_breadcrumb::trim().
  Bug fix: Minor tweaks to the tabs in the admin page to better support the new version of jQuery UI tabs (in WordPress 3.5+).
  Bug fix: Fixed issue where initial settings were not being translated due to the text domain not loading.
  Bug fix: Added verbiage to clarify what the “Post Parent” selection for “Post Hierarchy” does.
• 4.2.0 [9-28-2012]:
  Behaviour change: Date archives are only available for the “post” post type.
  New feature: All Custom Post Types can now either use a post parent, or taxonomy based hierarchy.
  New feature: Post Format archives are now supported.
  New feature: Reorganized settings page with more responsive elements.
  Bug fix: Widget will now display properly when told to include the paged breadcrumb on the main posts archive.
  Bug fix: Using flat taxonomies as the post hierarchy no longer causes extraneous breadcrumb templates to be applied.
  Bug fix: Mainsite link now works on posts and pages in multisite environments.
  Bug fix: bcn_breadcrumb::title_trim() no longer cuts HTML encoded characters.
  Bug fix: bcn_breadcrumb::title_trim() no longer trims the title when the title length is equal to the max length.
• 4.1.0 [6-5-2012]:
  Behaviour change: Made the behaviour of posts using flat taxonomies match the behaviour of using a hierarchical taxonomy when the post is not assigned a taxonomy term.
  New feature: Custom Post Types that are hierarchical can now fall back to a taxonomy if they don’t have a parent.
  New feature: Pretext option for the included Widget, allows ‘You are here: ‘ type messages in the widget.
  Bug fix: Textdomain was changed to the correct one in the widget.
  Bug fix: Textdomain was changed from ‘breadcrumb_navxt’ to ‘breadcrumb-navxt’ for improved compatibility with the new GlotPress translation flow.
  Bug fix: Fixed cause of PHP warnings on empty term archive pages.
  Bug fix: Fixed cause of PHP warnings on term archives restricted to a specified post type.
  Bug fix: Fixed cause of PHP warnings and improper behavior on author archives if showing the page number in the breadcrumb trail.
• 4.0.2 [2-17-2012]:
  New feature: Estonian translation added props to Martin Orn.
  New feature: Azerbaijani translation added props to Zaur Bayramov.
  Bug fix: Replaced deprecated RDFa and Microformat breadcrumbs with Schema.org breadcrumbs support in the included sidebar widget.
  Bug fix: Mainsite breadcrumbs are linked once again.
  Bug fix: Safe default settings for CPTs and taxonomies should work now.
  Bug fix: Updated translations should work, previously the old ones loaded.
• 4.0.1 [1-3-2012]:
  New feature: Norwegian translations added props to Jan Rosvoldsve.
  Bug fix: Fixed line 591 and line 646 errors in multisite installs.
  Bug fix: Attachments will now obey the root page setting for their parent, regardless of the parent’s post type.
• 4.0.0 [12-14-2011]:
  Behaviour change: Prefix, suffix, and anchor settings have been replaced with templates for all breadcrumb types.
  Behaviour change: bcn_display_nested function was removed from the main plugin. Will appear in a supplementary plugin.
  Behaviour change: Import/Export/Reset tab moved under the admin bar Help menu.
  Behaviour change: Paged breadcrumbs are enabled in the default settings, among other subtle changes.
  New feature: More useful Help menu, utilizing the new WordPress 3.3 Help menu.
  New feature: True URLs are now generated for current items when link current item is enabled.
  New feature: The display of the custom post type archive breadcrumb for custom post types may now be disabled.
  New feature: Added in fallback functions for PHP’s multibyte character string functions for environments that do not have multibyte character support.
  Bug fix: Custom post type archives now respect the root page setting.
  Bug fix: Custom post types without WordPress post archives enabled will no longer cause a double root page breadcrumb to be generated.
  Bug fix: Tabs on the settings page are now rounded for all “modern” browsers, including Firefox, Chrome, and IE9.
  Bug fix: Tabs on the settings page are now remembered between setting saves (including multiple saves from within the same tab).
  Bug fix: Fixed another cause of the “The following settings were not saved” error message.
• 3.9.0 [5-31-2011]:
  Behaviour change: Settings can not be saved, imported, or exported until any necessary settings updates and/or installs are completed.
  New feature: Support for WordPress 3.1 custom post type archives.
  Bug fix: Displays a warning message in the WordPress dashboard if PHP version is too old rather than trying to deactivate and dieing on all pages.
  Bug fix: Fixed a potential cause for the “options not saved” error.
  Bug fix: Fixed bug where the “Blog Breadcrumb” was not obeyed on archives.

To keep this page at a reasonable length, only versions 3.9 and newer 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.