morningtrain/wp-breadcrumbs

Autogenerated breadcrumbs for WordPress

v0.1.1 2023-01-20 11:13 UTC

MIT

• Martin Schadegg Brønniche

README

Autogenerated breadcrumbs for WordPress.

Table of Contents

• Introduction
• Getting Started
  • Installation
• Usage
• Credits
• License

Introduction

This package is made to make it simple to add breadcrumbs to WordPress.

Getting started

To get started install the package as described below in Installation.

To use the package have a look at Usage

Installation

Install with composer.

composer require morningtrain/wp-breadcrumbs

Usage

To get started with the module simply compose and render the breadcrumbs.

\Morningtrain\WP\Breadcrumbs\Breadcrumbs::compose()->render();

Change Seperator

You can change the seperator by calling seperator on the BreadcrumbGenerator.

\Morningtrain\WP\Breadcrumbs\Breadcrumbs::compose()->separator(' >> ')->render();

Hide on Front Page

You can easily hide the breadcrumbs on the frontpage by calling hideOnFrontPage on the BreadcrumbGenerator.

\Morningtrain\WP\Breadcrumbs\Breadcrumbs::compose()->hideOnFrontPage()->render();

Remove Prefixed Front Page

You can remove the prefixed front page breadcrumb on all pages by calling hidePrefixedFrontPagePart on the BreadcrumbGenerator.

\Morningtrain\WP\Breadcrumbs\Breadcrumbs::compose()->hidePrefixedFrontPagePart()->render();

Alternative to Render

If you will create your own markup, you can get all breadcrumb parts by calling getBreadcrumbs on the BreadcrumbGenerator.

\Morningtrain\WP\Breadcrumbs\Breadcrumbs::compose()->getBreadcrumbs();

Credits

• Martin Schadegg Brønniche
• All Contributors

License

The MIT License (MIT). Please see License File for more information.