Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/italystrap/breadcrumbs
Breadcrumbs Class API for WordPress
https://github.com/italystrap/breadcrumbs
Last synced: about 1 month ago
JSON representation
Breadcrumbs Class API for WordPress
- Host: GitHub
- URL: https://github.com/italystrap/breadcrumbs
- Owner: ItalyStrap
- License: mit
- Created: 2018-11-15T09:48:55.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-27T18:26:57.000Z (over 4 years ago)
- Last Synced: 2024-11-21T04:49:06.036Z (about 1 month ago)
- Language: PHP
- Size: 146 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ItalyStrap Breadcrumbs
[](https://packagist.org/packages/italystrap/breadcrumbs)
[](https://packagist.org/packages/italystrap/breadcrumbs)
[](https://www.codacy.com/app/overclokk/breadcrumbs?utm_source=github.com&utm_medium=referral&utm_content=ItalyStrap/breadcrumbs&utm_campaign=Badge_Grade)
[](https://travis-ci.org/ItalyStrap/breadcrumbs)
Breadcrumbs Class API for WordPress
This package create an HTML or Json Breadcrumbs elements to display on your WordPress site
## Installation
### Install with Composer
Add the package to your projects `composer.json` file. Visit [getcomposer.org](http://getcomposer.org/) more information.
```shell
composer require italystrap/breadcrumbs
```
or
```json
{
"require": {
"italystrap/breadcrumbs": "dev-master"
}
}
```
### Install Manually
Download and include the class file into your theme/plugin:
```php
include_once 'path/to/ItalyStrap/Breadcrumbs.php';
```
## Usage
### Basic usage
Use `\ItalyStrap\Breadcrumbs\Breadcrumbs_Factory::make( $type, $args )` to display the breadcrumbs in your template.
```php
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
## Options
An optional array of arguments can be passed to modify the breadcrumb output.
The defaults for each option @see `Breadcrumbs/config/breadcrumbs.php`
```php
/**
* Default configuration for Breadcrumbs
*/
return [
/**
* This is the container of the breadcrumbs
* @example ...
*/
'container_tag' => 'nav',
'container_attr' => [
'aria-label' => 'breadcrumb',
],
/**
* This is the list tag of the breadcrumbs
* @example
*/
'list_tag' => 'ol',
'list_attr' => [
'class' => 'breadcrumb',
'itemscope' => true,
'itemtype' => 'https://schema.org/BreadcrumbList',
],
/**
* This is the item tag of the breadcrumbs
* @example
*/
'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
*/
'home_icon' => false,
/**
* Separator for the items
* @example ' /'
*/
'separator' => false,
/**
* Show on front
* @default true
*/
'show_on_front' => true,
];
```
### Default HTML output
```html
```
## Advanced usage
### Example for HTML version
YOu can copy this snippet in your file breadcrumbs.php and include it in your plugin/theme
```php
/**
* 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.
### Example for Json version
```php
/**
* 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' );
```
## Filters
> TODO
## Other Example
> TODO
## array_insert()
`array_insert()` is a function that allows you to insert a new element into an array at a specific index.
### Example array_insert()
```php
/**
* 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' );
```
## Notes
* Licensed under the [GNU General Public License v2.0](https://github.com/ItalyStrap/breadcrumbs/blob/master/LICENSE)
* Maintained under the [Semantic Versioning Guide](http://semver.org)
## Author
**Enea Overclokk**
* [https://italystrap.com/](https://italystrap.com/)