Using the Breadcrumb Trail Block

Since version 6.3.0, Breadcrumb NavXT has shipped with a built in Gutenberg Block. In Breadcrumb NavXT version 7.3.0 the Breadcrumb Trail block was rewritten to have feature parity with the Widget. The Breadcrumb Trail block 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 block has a few settings available to the user.

Currently, the following settings are available:

  • 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 block still uses the settings values specified in the Breadcrumb NavXT settings page to define its behavior while filling the breadcrumb trail.

bcn_display_separator

This filter is applied within the bcn_breadcrumb_trail class in the display_loop() function just before assembling the breadcrumb string. This filter was introduced in version 7.2. It receives four parameters:

  • $separator(string)(required) The separator to place after the current breadcrumb.
  • $position(integer)(optional) The current breadcrumb position at the current depth in the breadcrumb trail
  • $last_position(integer)(optional) The last possible position at this depth of the breadcrumb trail (size of the breadcrumb trail at this depth)
  • $depth(integer)(optional) The current depth (dimension/level) within the breadcrumb trail

Related Articles

bcn_before_loop

This filter is applied within the bcn_breadcrumb_trail class in the display_loop() function at the beginning of the function. This filter was introduced in version 7.1. It receives one parameter:

  • $breadcrumbs(array)(required) The array of bcn_breadcrumb objects that comprise the breadcrumb trail.

bcn_opts_update_to_save

This filter is applied within the mtekk\adminKit\adminKit class in the opts_update() function just before saving the settings to the option entry. This filter was introduced in version 7.0. It receives one parameter:

  • $settings_diff(array)(required) The array of non-default valued mtekk\adminKit\setting objects which will be saved to the option entry.
Updated:

bcn_paths_tax_use_query_var

This filter allows control over the query variable Breadcrumb NavXT Paths uses to find referring terms. This filter was introduced in 1.8.0. It receives three parameters:

  • $use_query_var(bool)(required) Whether or not to use the query variable specified in the second parameter for the taxonomy specified in the third parameter
  • $query_var(string)(optional) The query variable Breadcrumb NavXT intends to use to find the referring term
  • $taxonomy(WP_Taxonomy)(optional) The taxonomy that the query variable is being checked against for validity