Site Breadcrumbs

For situations where you need to change the behavior of the breadcrumbs conditionally, there is now a PHP filter to change the items (the crumbs) in the breadcrumb trail.

add_filter( 'bricksextras/breadcrumbs/', function( $crumbs ) {

    // $crumbs is an array of the items inside the breadcrumb trail.
    return $crumbs;
});

Being familiar with PHP conditions and WordPress functions will be required, but here are some examples just to show it in action.

Examples

For single posts that are automatically put in the uncategorized category, by default if you have chosen to display categories you’d see this – Home > Uncategorized > Post Title.  (here the $crumbs array would contain three items, one for each crumb in the trail.)

Example 1: Replace any string (say we want to change the uncategorized archive link URL. We want it to change from ‘category/uncategorized/’ to ‘my-custom-page/’)

add_filter( 'bricksextras/breadcrumbs/', function( $crumbs ) {

  if ( is_singular('post') && in_category('uncategorized') ) {
		
      /* replace 'category/uncategorized/' in the link URL 
         with 'my-custom-page/' */
      if ( isset( $crumbs[1] ) ) {

        $crumbs[1] = str_replace( 'category/uncategorized/', 'my-custom-page/', $crumbs[1] );

      }
  }

 
  return $crumbs;

});

Example 2: Remove a crumb (say we want to remove the uncategorized item from the array altogether)

add_filter( 'bricksextras/breadcrumbs/', function( $crumbs ) {

  if ( is_singular('post') && in_category('uncategorized') ) {
		
      /* remove the second item (index 1) from the array */
      if ( isset( $crumbs[1] ) ) {
        unset( $crumbs[1] );
      }
  }

 
  return $crumbs;

});

Example 3: Insert a new crumb (Say we have a CPT named ‘product’ (not WooCommerce product), and a custom taxonomy ‘product-category’.  if the product being viewed has a product-category, add that category archive page link to the breadcrumbs)

Here we need to add a new item to the array. There’s a helper function for creating a new crumb with the correct markup.

\BricksExtras\Helpers::breadcrumb_item($url, $text, $maybeLink, $maybeSchema)

Parameters;

• $url (string): The URL of the breadcrumb item
• $text (string): The text to display
• $maybeLink (boolean): Whether to output as a link (optional, defaults to true)
• $maybeSchema (boolean): Whether to include schema markup (optional, defaults to true)

add_filter( 'bricksextras/breadcrumbs/', function( $crumbs ) {

  $myPostType = 'product'; /* post type */
  $myTaxononmy = 'product-category'; /* taxonomy */
  $crumbPosition = 2; /* position in the breadcrumbs (0 for first) */

	
  if ( is_singular('product') && taxonomy_exists( $myTaxononmy ) ) {
		
    $productCategories = get_the_terms(get_the_ID(), $myTaxononmy );
		
      if ( !empty ( $productCategories ) ) {
        
        /* get the URL and link text for the new crumb */
        $url = get_term_link($productCategories[0]->slug, $myTaxononmy);
        $text = $productCategories[0]->name;
			
        /* using helper function to build new crumb item */
	$newCrumb = \BricksExtras\Helpers::breadcrumb_item($url,$text);
			
          /* add to the $crumbs array in the position needed */
	  array_splice($crumbs, $crumbPosition, 0, $newCrumb);
			
      }
		
   }

 
  return $crumbs;

});

Now for any products that have a product-category, instead of being output as Home > Product Title, it would output as Home > Product Category Name >  Product Title with the second item being a link to that product category archive page.