Documentation

Notice: This document, in the next few weeks, will undergo a transformation from documenting the core classes of Breadcrumb NavXT to providing usage examples for Breadcrumb NavXT. Information regarding the core classes is available in the source code (nearly every line of code has an accompanying comment line). Users interested in the inner workings of the core classes should check out the Trac browser for the Breadcrumb NavXT Trunk.

Table of Contents

1. Using Breadcrumb NavXT
   1. Using the Settings Page
   2. Using the Widget
2. Action Reference
3. Code Examples
   1. CSS Styling
   2. Direct Class Access

Using Breadcrumb NavXT

Using the Settings Page

Breadcrumb Templates

Introduced in version 4.0.0, breadcrumb templates replace the anchor templates and the prefix and suffix settings. These templates accept HTML, and the following dynamic tags:

• %title% The title for the breadcrumb, typically the page title/name, tags are stripped and it is run through esc_attr().
• %htitle% The title for the breadcrumb, typically the page title/name, tags are left intact.
• %link% The URL to the resource (page) that the breadcrumb represents.
• %type% The breadcrumb type. This is output as a comma delimited list, useful for setting as a group of classes for styling.

Using the Widget

Since version 3.0.0, Breadcrumb NavXT has shipped with a built in WordPress sidebar widget. In Breadcrumb NavXT version 3.5.0 the included widget was rewritten and is multi instance capable. The widget allows you to place a breadcrumb trail in your theme without touching any of your theme’s files. Since Breadcrumb NavXT has a two different display functions (bcn_display() and bcn_display_list()), along with three input variables for these functions ($return, $linked, $reverse), the widget has a few settings available to the user.

Currently, the following settings are available:

• A field to enter a title for the output widget, this works just like the title on any other widget.
• Whether to output the trail as a list or not. If checked, the output trail will be placed in an unordered list, with each breadcrumb belonging to its own list element.
• Whether to link the breadcrumbs or not. If checked (default), each of the breadcrumbs in the breadcrumb trail will have a hyperlink.
• Whether to reverse the order of the trail or not. If checked, the breadcrumb trail will be output in reverse order (the leftmost breadcrumb (or first breadcrumb in a list output) will be the breadcrumb for current page).
• Whether to hide the trail on the front page or not. If checked, the breadcrumb trail for the front page of your site will not be displayed (e.g. when is_front_page() evaluates to true).

The widget still uses the settings values specified in the Breadcrumb NavXT settings page to define its behavior while filling the breadcrumb trail.

Pages: 1 2 3