Breadcrumbs Class API for WordPress
This package create an HTML or Json Breadcrumbs elements to display on your WordPress site
Add the package to your projects composer.json file. Visit getcomposer.org more information.
composer require italystrap/breadcrumbsor
{
"require": {
"italystrap/breadcrumbs": "dev-master"
}
}Download and include the class file into your theme/plugin:
include_once 'path/to/ItalyStrap/Breadcrumbs.php';Use \ItalyStrap\Breadcrumbs\Breadcrumbs_Factory::make( $type, $args ) to display the breadcrumbs in your template.
use ItalyStrap\Breadcrumbs;
echo Breadcrumbs_Factory::make( 'html', $args );
// Or
echo Breadcrumbs_Factory::make( 'json', $args );The first parameter is the type of breadcrumbs you want to display:
- HTML
- Return the HTML output
- Json
- Return the Json output
- object
- Return the object output
- array
- Return the array output
An optional array of arguments can be passed to modify the breadcrumb output.
The defaults for each option @see Breadcrumbs/config/breadcrumbs.php
/**
* Default configuration for Breadcrumbs
*/
return [
/**
* This is the container of the breadcrumbs
* @example <nav aria-label="breadcrumb">...</nav>
*/
'container_tag' => 'nav',
'container_attr' => [
'aria-label' => 'breadcrumb',
],
/**
* This is the list tag of the breadcrumbs
* @example <ol class="breadcrumb" itemscope itemtype="https://schema.org/BreadcrumbList">...</ol>
*/
'list_tag' => 'ol',
'list_attr' => [
'class' => 'breadcrumb',
'itemscope' => true,
'itemtype' => 'https://schema.org/BreadcrumbList',
],
/**
* This is the item tag of the breadcrumbs
* @example <li class="breadcrumb-item [...active]" itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem">...</li>
*/
'item_tag' => 'li',
'item_attr' => [
'class' => "breadcrumb-item",
'itemprop' => 'itemListElement',
'itemscope' => true,
'itemtype' => 'https://schema.org/ListItem',
],
/**
* Css class for active element
*/
'item_attr_class_active' => ' active',
/**
* It could be passed an HTML icon to show instead of the firt element (home)
* @example <span class="glyphicon glyphicon-home" aria-hidden="true"></span>
*/
'home_icon' => false,
/**
* Separator for the items
* @example ' /'
*/
'separator' => false,
/**
* Show on front
* @default true
*/
'show_on_front' => true,
];<nav aria-label="breadcrumb">
<ol class="breadcrumb" itemscope="" itemtype="https://schema.org/BreadcrumbList">
<meta name="numberOfItems" content="2">
<meta name="itemListOrder" content="Ascending">
<li class="breadcrumb-item" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem">
<a itemprop="item" href="http://192.168.1.10/italystrap/">
<span itemprop="name">ItalyStrap</span></a>
<meta itemprop="position" content="1">
</li>
<li class="breadcrumb-item active" itemprop="itemListElement" itemscope="" itemtype="https://schema.org/ListItem" aria-current="page">
<a itemprop="item" href="http://192.168.1.10/italystrap/blog/">
<span itemprop="name">Blog</span></a>
<meta itemprop="position" content="2">
</li>
</ol>
</nav>YOu can copy this snippet in your file breadcrumbs.php and include it in your plugin/theme
/**
* Get the Breadcrumbs
*
* @param array $args The breadcrumbs arguments.
* @see class Breadcrumbs for more info.
* @return string Return the breadcrumbs html.
*/
function get_breadcrumbs( array $args = array() ) {
$args['bloginfo_name'] = GET_BLOGINFO_NAME;
$args['home_url'] = HOME_URL;
$args['separator'] = false;
$args['show_on_front'] = false;
try {
return apply_filters(
'italystrap_get_the_breadcrumbs',
\ItalyStrap\Breadcrumbs\Breadcrumbs_Factory::make( 'html', $args ),
$args
);
} catch ( Exception $e ) {
echo $e->getMessage();
}
}
/**
* Print the Breadcrumbs
*
* @param array $args The breadcrumbs arguments.
* @see class Breadcrumbs for more info.
* @return string Return the breadcrumbs html.
*/
function breadcrumbs( array $args = array() ) {
echo get_breadcrumbs( $args );
}
/**
* Do breadcrumbs
*
* @since 2.2.0
*
* @param array $args The breadcrumbs arguments.
*/
function do_breadcrumbs( array $args = array() ) {
breadcrumbs( $args );
}
add_action( 'do_breadcrumbs', __NAMESPACE__ . '\do_breadcrumbs' );Then with the function do_action( 'do_breadcrumbs', [] ) you can display the breadcrumbs where you want in your theme.
/**
* Get the Breadcrumbs
*
* @param array $args The breadcrumbs arguments.
* @see class Breadcrumbs for more info.
* @return string Return the breadcrumbs html.
*/
function get_breadcrumbs( array $args = array() ) {
$args['bloginfo_name'] = GET_BLOGINFO_NAME;
$args['home_url'] = HOME_URL;
$args['show_on_front'] = false;
try {
return apply_filters(
'italystrap_get_the_breadcrumbs',
\ItalyStrap\Breadcrumbs\Breadcrumbs_Factory::make( 'json', $args ),
$args
);
} catch ( Exception $e ) {
echo $e->getMessage();
}
}
/**
* Print the Breadcrumbs
*
* @param array $args The breadcrumbs arguments.
* @see class Breadcrumbs for more info.
* @return string Return the breadcrumbs html.
*/
function breadcrumbs( array $args = array() ) {
echo get_breadcrumbs( $args );
}
/**
* Do breadcrumbs
*
* @since 2.2.0
*
* @param array $args The breadcrumbs arguments.
*/
function do_breadcrumbs( array $args = array() ) {
breadcrumbs( $args );
}
add_action( 'wp_footer', __NAMESPACE__ . '\do_breadcrumbs' );TODO
TODO
array_insert() is a function that allows you to insert a new element into an array at a specific index.
/**
* Modify breadcrums list
*
* @param {array} $list
*
* @return {array}
*/
function modify_breadcrumbs_list( array $list ) {
// if on the events category archive page
if( is_tax( 'event-categories' ) ) {
// create a new element
$element = [
'title' => "Shows",
'url' => site_url( '/shows' )
];
// add the new element at the index of 1
$list = array_insert( $list, $element, 1 );
}
return $list;
}
add_filter( 'ItalyStrap\Breadcrumbs\Container\Items', 'modify_breadcrumbs_list' );- Licensed under the GNU General Public License v2.0
- Maintained under the Semantic Versioning Guide
Enea Overclokk