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.

bcn_add_post_type_arg

This filter is applied within the breadcrumb_navxt_trail class in the maybe_add_post_type_arg() function. This filter was introduced in version 5.4. It receives three parameters:

  • $add_query_arg(boolean)(required) The boolean decision whether or not to add the post type query argument to the URL to filter
  • $type(string)(optional) The name of the post type that is under consideration for addition to the URL
  • $taxonomy(string|NULL)(optional) The taxonomy name for the archive in question (may be null)

Related Articles

Updated:

bcn_pick_post_term

This filter is applied within the bcn_breadcrumb_trail class in the post_hierarchy() function. This filter was introduced in version 5.4 with three parameters. In version 5.5 a fourth parameter was added. It receives four parameters:

  • $term(WP_Term|boolean)(required) The term object returned by bcn_breadcrumb_trail::pick_post_terms() to filter (note that this parameter may be the boolean value false)
  • $id(id)(optional) The ID of the post this term is for
  • $type(string)(optional) The post type name for the post represented by the ID in the second parameter
  • $taxonomy(string)(optional) The name of the taxonomy the term belongs to
Updated:

bcn_post_terms

This filter is applied within the breadcrumb_navxt_trail class in the post_terms() function. This filter was introduced in version 5.4. It receives three parameters:

  • $terms(array)(required) The array of term objects returned by get_the_terms() to filter
  • $taxonomy(string)(optional) The name of the taxonomy for the terms
  • $id(int)(optional) The ID of the post the terms are for

Related Articles

Updated:

bcn_type_archive_post_type

This filter is applied within the breadcrumb_navxt_trail class in the type_archive() function. This filter was introduced in version 5.2. It receives one parameter:

  • $post_type(string)(required) The name of the post type to use for the post type archive breadcrumb
Updated: