WordPress.org

Plugin Directory

wiki:BreadcrumbNavigation

Breadcrumb Navigation 0.8.1

I am pleased to annouce the Breadcrumb Navigation 0.8.1 plugin for WordPress 1.2 and 1.2.1. Many features have been added and documentation is much clearer and concise.
To use the plugin:

  1. Drop into your plugins directory and activate.
  2. Edit your index.php file and add this where you would like the breadcrumb to show:
    <?php get_breadcrumb(); ?>
    Note: the breadcrumb can be placed anywhere but inside “the loop"; however, the best place is right after <div id="content">.
  3. View website to confirm proper operation
  4. Stir and Enjoy!

[- See it in action | Download zip or gzip -]

The above links do not work

now work - mark, the latest version of the plugin is available from the authors site. Development has now apparently stopped as the plugin is "feature" complete. The documentation for versions 0.8.1 is stil accurate.


0.8.1 Changes and Notes:
  • Code has been cleaned up and changed quite a bit. More options for customizing the output without modifying the plugin itself have been added.
  • Translation friendliness has been preserved from the previous version.
  • This plugin does not currently support “nice” permalinks. [Note: this feature is known to work with a particular setup. Please see this page for more details.]
  • Support for WordPress 1.3 is experimental; some changing of the index.php file is required. Full support for WordPress 1.3 will most likely be completed shortly after a stable version is released (including “nice” permalinks).

Credits:

  • Me!
  • Thanks to lennart for the code and idea on which this plugin is based.
  • Thanks to Mark Jaquith and Tor Bjornrud of the WordPress Hackers mailing list for assistance with integrating and refining the code to work as a one-line function in index.php.

Note: skip this section if you do not wish to configure the breadcrumb plugin. The default settings work fine.
For advanced users (or those feeling adventurous), there are parameters available to configure the plugin. Cauton: users of previous versions will not be able to use the same options and options order as they have changed.

<?php get_breadcrumb('rootName', showRoot, showRP, showOnSingle, 'prefix', 'sep', 'divid', usedis, 'dividSingle', uselfsp); ?>

Parameters:

  • ‘rootName’ - string - What text to show as the home link. Can be any text. Default is ‘Home’.
  • showRoot - boolean - Whether the home link will be displayed always (TRUE) or only when viewing anything but the front page (FALSE). Default is TRUE.
  • showRP - boolean - Whether to show the home link ‘prefix’ (TRUE) or not (FALSE). Note: if showRoot is set to FALSE, ‘prefix’ (which showRP controls) will never show on the front page, regardless of the value for showRP.
  • showOnSingle - boolean - Whether to show the breadcrumb when viewing a single post (TRUE) or not (FALSE). Useful for reducing redundancy and unnecessity (no need to view the breadcrumb that contains the categories and the title of the post when the information is already there). Default is TRUE.
  • ‘prefix’ - string - What text to show directly preceding the home link. Can be any text. Default is » (&raquo;).
  • ’sep’ - string - What text to show between different components of the breadcrumb. Can be any text (spaces between components, however, are hardcoded). Default is > (&gt;).
  • ‘divid’ - string - What text to assign to #id of the div that encloses the breadcrumb. Can be any text. Default is ‘breadcrumb’.
  • usedis - boolean - Whether to use the ‘dividSingle’ on the #id of the breadcrumb div when viewing a single post (TRUE) or use ‘divid’ (FALSE). Default is FALSE.
  • ‘dividSingle’ - string - What text to to assign to the #id of the breadcrumb div when viewing a single post. This parameter has no effect if usedis is set to (FALSE). Default is breadcrumb_single.
  • uselfsp - boolean - Whether to display the title of the post part of the breadcrumb as a link (TRUE) or plain text (FALSE). Useful in cojunction with ‘dividSingle’ to get a different style and display. Default is FALSE.

The breadcrumb displays perfectly fine with the normal output; however, some may wish to style it, therefore the breadcrumb is enclosed in a div tag so CSS may be applied to it. Example:

#breadcrumb {
	font-family: 'Times New Roman', Times, serif;
	background: #EEEEFF;
	border: solid 1px #000000;
	padding: 2px;
}

Place this code in the wp-layout.css file.

Last modified 12 years ago Last modified on 10/09/05 17:28:45