Laravel Breadcrumbs - A simple Laravel-style way to create breadcrumbs
Clone or download
Latest commit fc273f4 Oct 16, 2018

Laravel Breadcrumbs

Latest Stable Version Total Downloads Monthly Downloads License
Latest Unstable Version Build Status Coverage Status

A simple Laravel-style way to create breadcrumbs.

Table of Contents

Compatibility Chart

Laravel Breadcrumbs Laravel PHP
5.1.1+ 5.6 – 5.7 7.1+
5.0.0 – 5.1.0 5.6 7.1+
4.x 5.5 7.0+
3.x 5.0 – 5.4 5.4+
2.x 4.0 – 4.2 5.3+

Getting Started

Note: If you are using an older version, click it in the table above to see the documentation for that version.

1. Install Laravel Breadcrumbs

Run this at the command line:

composer require davejamesmiller/laravel-breadcrumbs:5.x

This will update composer.json and install the package into the vendor/ directory.

2. Define your breadcrumbs

Create a file called routes/breadcrumbs.php that looks like this:


// Home
Breadcrumbs::for('home', function ($trail) {
    $trail->push('Home', route('home'));

// Home > About
Breadcrumbs::for('about', function ($trail) {
    $trail->push('About', route('about'));

// Home > Blog
Breadcrumbs::for('blog', function ($trail) {
    $trail->push('Blog', route('blog'));

// Home > Blog > [Category]
Breadcrumbs::for('category', function ($trail, $category) {
    $trail->push($category->title, route('category', $category->id));

// Home > Blog > [Category] > [Post]
Breadcrumbs::for('post', function ($trail, $post) {
    $trail->parent('category', $post->category);
    $trail->push($post->title, route('post', $post->id));

See the Defining Breadcrumbs section for more details.

3. Choose a template

By default a Bootstrap-compatible ordered list will be rendered, so if you're using Bootstrap 4 you can skip this step.

First initialise the config file by running this command:

php artisan vendor:publish --provider="DaveJamesMiller\Breadcrumbs\BreadcrumbsServiceProvider"

Then open config/breadcrumbs.php and edit this line:

    'view' => 'breadcrumbs::bootstrap4',

The possible values are:

See the Custom Templates section for more details.

4. Output the breadcrumbs

Finally, call Breadcrumbs::render() in the view for each page, passing it the name of the breadcrumb to use and any additional parameters – for example:

{{ Breadcrumbs::render('home') }}

{{ Breadcrumbs::render('category', $category) }}

See the Outputting Breadcrumbs section for other output options, and see Route-Bound Breadcrumbs for a way to link breadcrumb names to route names automatically.

Defining Breadcrumbs

Breadcrumbs will usually correspond to actions or types of page. For each breadcrumb you specify a name, the breadcrumb title and the URL to link it to. Since these are likely to change dynamically, you do this in a closure, and you pass any variables you need into the closure.

The following examples should make it clear:

Static pages

The most simple breadcrumb is probably going to be your homepage, which will look something like this:

Breadcrumbs::for('home', function ($trail) {
     $trail->push('Home', route('home'));

As you can see, you simply call $trail->push($title, $url) inside the closure.

For generating the URL, you can use any of the standard Laravel URL-generation methods, including:

  • url('path/to/route') (URL::to())
  • secure_url('path/to/route')
  • route('routename') or route('routename', 'param') or route('routename', ['param1', 'param2']) (URL::route())
  • action('controller@action') (URL::action())
  • Or just pass a string URL ('')

This example would be rendered like this:

{{ Breadcrumbs::render('home') }}

And results in this output:


Parent links

This is another static page, but this has a parent link before it:

Breadcrumbs::for('blog', function ($trail) {
    $trail->push('Blog', route('blog'));

It works by calling the closure for the home breadcrumb defined above.

It would be rendered like this:

{{ Breadcrumbs::render('blog') }}

And results in this output:

Home / Blog

Note that the default template does not create a link for the last breadcrumb (the one for the current page), even when a URL is specified. You can override this by creating your own template – see Custom Templates for more details.

Dynamic titles and links

This is a dynamically generated page pulled from the database:

Breadcrumbs::for('post', function ($trail, $post) {
    $trail->push($post->title, route('post', $post));

The $post object would simply be passed in from the view:

{{ Breadcrumbs::render('post', $post) }}

It results in this output:

Home / Blog / Post Title

Tip: You can pass multiple parameters if necessary.

Nested categories

Finally, if you have nested categories or other special requirements, you can call $trail->push() multiple times:

Breadcrumbs::for('category', function ($trail, $category) {

    foreach ($category->ancestors as $ancestor) {
        $trail->push($ancestor->title, route('category', $ancestor->id));

    $trail->push($category->title, route('category', $category->id));

Alternatively you could make a recursive function such as this:

Breadcrumbs::for('category', function ($trail, $category) {
    if ($category->parent) {
        $trail->parent('category', $category->parent);
    } else {

    $trail->push($category->title, route('category', $category->slug));

Both would be rendered like this:

{{ Breadcrumbs::render('category', $category) }}

And result in this:

Home / Blog / Grandparent Category / Parent Category / Category Title

Custom Templates

Create a view

To customise the HTML, create your own view file (e.g. resources/views/partials/breadcrumbs.blade.php) like this:

@if (count($breadcrumbs))

    <ol class="breadcrumb">
        @foreach ($breadcrumbs as $breadcrumb)

            @if ($breadcrumb->url && !$loop->last)
                <li class="breadcrumb-item"><a href="{{ $breadcrumb->url }}">{{ $breadcrumb->title }}</a></li>
                <li class="breadcrumb-item active">{{ $breadcrumb->title }}</li>



(See the views/ directory for the built-in templates.)

View data

The view will receive an array called $breadcrumbs.

Each breadcrumb is an object with the following keys:

  • title – The breadcrumb title
  • url – The breadcrumb URL, or null if none was given
  • Plus additional keys for each item in $data (see Custom data)

Update the config

Then update your config file (config/breadcrumbs.php) with the custom view name, e.g.:

    'view' => 'partials.breadcrumbs', #--> resources/views/partials/breadcrumbs.blade.php

Skipping the view

Alternatively you can skip the custom view and call Breadcrumbs::generate() to get the breadcrumbs Collection directly:

@foreach (Breadcrumbs::generate('post', $post) as $breadcrumb)
    {{-- ... --}}

Outputting Breadcrumbs

Call Breadcrumbs::render() in the view for each page, passing it the name of the breadcrumb to use and any additional parameters.

With Blade

In the page (e.g. resources/views/home.blade.php):

{{ Breadcrumbs::render('home') }}

Or with a parameter:

{{ Breadcrumbs::render('category', $category) }}

With Blade layouts and @section

In the page (e.g. resources/views/home.blade.php):


@section('breadcrumbs', Breadcrumbs::render('home'))

In the layout (e.g. resources/views/app.blade.php):


Pure PHP (without Blade)

In the page (e.g. resources/views/home.php):

<?= Breadcrumbs::render('home') ?>

Or use the long-hand syntax if you prefer:

<?php echo Breadcrumbs::render('home') ?>

Structured Data

To render breadcrumbs as JSON-LD structured data (usually for SEO reasons), use Breadcrumbs::view() to render the breadcrumbs::json-ld template in addition to the normal one. For example:

        {{ Breadcrumbs::view('breadcrumbs::json-ld', 'category', $category) }}
        {{ Breadcrumbs::render('category', $category) }}

(Note: If you use Laravel Page Speed you may need to disable the TrimUrls middleware.)

To specify an image, add it to the $data parameter in push():

Breadcrumbs::for('post', function ($trail, $post) {
    $trail->push($post->title, route('post', $post), ['image' => asset($post->image)]);

(If you prefer to use Microdata or RDFa you will need to create a custom template.)

Route-Bound Breadcrumbs

In normal usage you must call Breadcrumbs::render($name, $params...) to render the breadcrumbs on every page. If you prefer, you can name your breadcrumbs the same as your routes and avoid this duplication...

Name your routes

Make sure each of your routes has a name. For example (routes/web.php):

// Home
Route::name('home')->get('/', 'HomeController@index');

// Home > [Post]
Route::name('post')->get('/post/{id}', 'PostController@show');

For more details see Named Routes in the Laravel documentation.

Name your breadcrumbs to match

For each route, create a breadcrumb with the same name and parameters. For example (routes/breadcrumbs.php):

// Home
Breadcrumbs::for('home', function ($trail) {
     $trail->push('Home', route('home'));

// Home > [Post]
Breadcrumbs::for('post', function ($trail, $id) {
    $post = Post::findOrFail($id);
    $trail->push($post->title, route('post', $post));

To add breadcrumbs to a custom 404 Not Found page, use the name errors.404:

// Error 404
Breadcrumbs::for('errors.404', function ($trail) {
    $trail->push('Page Not Found');

Output breadcrumbs in your layout

Call Breadcrumbs::render() with no parameters in your layout file (e.g. resources/views/app.blade.php):

{{ Breadcrumbs::render() }}

This will automatically output breadcrumbs corresponding to the current route. The same applies to Breadcrumbs::generate():

$breadcrumbs = Breadcrumbs::generate();

And to Breadcrumbs::view():

{{ Breadcrumbs::view('breadcrumbs::json-ld') }}

Route binding exceptions

It will throw an InvalidBreadcrumbException if the breadcrumb doesn't exist, to remind you to create one. To prevent this, first initialise the config file, if you haven't already:

php artisan vendor:publish --provider="DaveJamesMiller\Breadcrumbs\BreadcrumbsServiceProvider"

Then open config/breadcrumbs.php and set this value:

    'missing-route-bound-breadcrumb-exception' => false,

Similarly to prevent it throwing an UnnamedRouteException if the current route doesn't have a name set this value:

    'unnamed-route-exception' => false,

Route model binding

Laravel Breadcrumbs uses the same model binding as the controller. For example:

// routes/web.php
Route::name('post')->get('/post/{post}', 'PostController@show');
// app/Http/Controllers/PostController.php
use App\Post;

class PostController extends Controller
    public function show(Post $post) // <-- Implicit model binding happens here
        return view('post/show', ['post' => $post]);
// routes/breadcrumbs.php
Breadcrumbs::for('post', function ($trail, $post) { // <-- The same Post model is injected here
    $trail->push($post->title, route('post', $post));

This makes your code less verbose and more efficient by only loading the post from the database once.

For more details see Route Model Binding in the Laravel documentation.

Resourceful controllers

Laravel automatically creates route names for resourceful controllers, e.g. photo.index, which you can use when defining your breadcrumbs. For example:

// routes/web.php
Route::resource('photo', PhotoController::class);
$ php artisan route:list
| Domain | Method   | URI                | Name          | Action                  | Middleware |
|        | GET|HEAD | photo              | photo.index   | PhotoController@index   |            |
|        | GET|HEAD | photo/create       | photo.create  | PhotoController@create  |            |
|        | POST     | photo              |   | PhotoController@store   |            |
|        | GET|HEAD | photo/{photo}      |    | PhotoController@show    |            |
|        | GET|HEAD | photo/{photo}/edit | photo.edit    | PhotoController@edit    |            |
|        | PUT      | photo/{photo}      | photo.update  | PhotoController@update  |            |
|        | PATCH    | photo/{photo}      |               | PhotoController@update  |            |
|        | DELETE   | photo/{photo}      | photo.destroy | PhotoController@destroy |            |
// routes/breadcrumbs.php

// Photos
Breadcrumbs::for('photo.index', function ($trail) {
    $trail->push('Photos', route('photo.index'));

// Photos > Upload Photo
Breadcrumbs::for('photo.create', function ($trail) {
    $trail->push('Upload Photo', route('photo.create'));

// Photos > [Photo Name]
Breadcrumbs::for('', function ($trail, $photo) {
    $trail->push($photo->title, route('', $photo->id));

// Photos > [Photo Name] > Edit Photo
Breadcrumbs::for('photo.edit', function ($trail, $photo) {
    $trail->parent('', $photo);
    $trail->push('Edit Photo', route('photo.edit', $photo->id));

For more details see Resource Controllers in the Laravel documentation.

Advanced Usage

Breadcrumbs with no URL

The second parameter to push() is optional, so if you want a breadcrumb with no URL you can do so:


The $breadcrumb->url value will be null.

The default Bootstrap templates provided render this with a CSS class of "active", the same as the last breadcrumb, because otherwise they default to black text not grey which doesn't look right.

Custom data

The push() method accepts an optional third parameter, $data – an array of arbitrary data to be passed to the breadcrumb, which you can use in your custom template. For example, if you wanted each breadcrumb to have an icon, you could do:

$trail->push('Home', '/', ['icon' => 'home.png']);

The $data array's entries will be merged into the breadcrumb as properties, so you would access the icon as $breadcrumb->icon in your template, like this:

<li><a href="{{ $breadcrumb->url }}">
    <img src="/images/icons/{{ $breadcrumb->icon }}">
    {{ $breadcrumb->title }}

Do not use the keys title or url as they will be overwritten.

Before and after callbacks

You can register "before" and "after" callbacks to add breadcrumbs at the start/end of the trail. For example, to automatically add the current page number at the end:

Breadcrumbs::after(function ($trail) {
    $page = (int) request('page', 1);
    if ($page > 1) {
        $trail->push("Page $page");

Getting the current page breadcrumb

To get the last breadcrumb for the current page, use Breadcrumb::current(). For example, you could use this to output the current page title:

<title>{{ ($breadcrumb = Breadcrumbs::current()) ? $breadcrumb->title : 'Fallback Title' }}</title>

To ignore a breadcrumb, add 'current' => false to the $data parameter in push(). This can be useful to ignore pagination breadcrumbs:

Breadcrumbs::after(function ($trail) {
    $page = (int) request('page', 1);
    if ($page > 1) {
        $trail->push("Page $page", null, ['current' => false]);
    {{ ($breadcrumb = Breadcrumbs::current()) ? "$breadcrumb->title" : '' }}
    {{ ($page = (int) request('page')) > 1 ? "Page $page" : '' }}
    Demo App

For more advanced filtering, use Breadcrumbs::generate() and Laravel's Collection class methods instead:

$current = Breadcrumbs::generate()->where('current', '!==', 'false)->last();

Switching views at runtime

You can use Breadcrumbs::view() in place of Breadcrumbs::render() to render a template other than the default one:

{{ Breadcrumbs::view('partials.breadcrumbs2', 'category', $category) }}

Or you can override the config setting to affect all future render() calls:

Config::set('breadcrumbs.view', 'partials.breadcrumbs2');
{{ Breadcrumbs::render('category', $category) }}

Or you could call Breadcrumbs::generate() to get the breadcrumbs Collection and load the view manually:

@include('partials.breadcrumbs2', ['breadcrumbs' => Breadcrumbs::generate('category', $category)])

Overriding the "current" route

If you call Breadcrumbs::render() or Breadcrumbs::generate() with no parameters, it will use the current route name and parameters by default (as returned by Laravel's Route::current() method).

You can override this by calling Breadcrumbs::setCurrentRoute($name, $param1, $param2...).

Checking if a breadcrumb exists

To check if a breadcrumb with a given name exists, call Breadcrumbs::exists('name'), which returns a boolean.

Defining breadcrumbs in a different file

If you don't want to use routes/breadcrumbs.php, you can change it in the config file. First initialise the config file, if you haven't already:

php artisan vendor:publish --provider="DaveJamesMiller\Breadcrumbs\BreadcrumbsServiceProvider"

Then open config/breadcrumbs.php and edit this line:

    'files' => base_path('routes/breadcrumbs.php'),

It can be an absolute path, as above, or an array:

    'files' => [

So you can use glob() to automatically find files using a wildcard:

    'files' => glob(base_path('breadcrumbs/*.php')),

Or return an empty array [] to disable loading.

Defining/using breadcrumbs in another package

If you are creating your own package, simply load your breadcrumbs file from your service provider's boot() method:

use Illuminate\Support\ServiceProvider;

class MyServiceProvider extends ServiceProvider
    public function register() {}

    public function boot()
        if (class_exists('Breadcrumbs')) {
            require __DIR__ . '/breadcrumbs.php';

Dependency injection

You can use dependency injection to access the BreadcrumbsManager instance if you prefer, instead of using the Breadcrumbs:: facade:

use DaveJamesMiller\Breadcrumbs\BreadcrumbsManager;
use Illuminate\Support\ServiceProvider;

class MyServiceProvider extends ServiceProvider
    public function register() {}

    public function boot(BreadcrumbsManager $breadcrumbs)


The BreadcrumbsManager class is macroable, so you can add your own methods. For example:

Breadcrumbs::macro('pageTitle', function () {
    $title = ($breadcrumb = Breadcrumbs::current()) ? "{$breadcrumb->title} – " : '';

    if (($page = (int) request('page')) > 1) {
        $title .= "Page $page";

    return $title . 'Demo App';
<title>{{ Breadcrumbs::pageTitle() }}</title>

Or you could use it to add a Breadcrumbs::resource() shorthand method [1][2].

Advanced customisations

For more advanced customisations you can subclass BreadcrumbsManager and/or BreadcrumbsGenerator, then update the config file with the new class name:

    // Manager
    'manager-class' => DaveJamesMiller\Breadcrumbs\BreadcrumbsManager::class,

    // Generator
    'generator-class' => DaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator::class,

(Note: Anything that's not part of the public API (see below) may change between releases, so I suggest you write unit tests to ensure it doesn't break when upgrading.)

API Reference

Breadcrumbs Facade

Method Returns Added in
Breadcrumbs::for(string $name, closure $callback) void 5.1.0
Breadcrumbs::register(string $name, closure $callback) void 1.0.0
Breadcrumbs::before(closure $callback) void 4.0.0
Breadcrumbs::after(closure $callback) void 4.0.0
Breadcrumbs::exists() boolean 2.2.0
Breadcrumbs::exists(string $name) boolean 2.2.0
Breadcrumbs::generate() Collection 2.2.3
Breadcrumbs::generate(string $name) Collection 1.0.0
Breadcrumbs::generate(string $name, mixed $param1, ...) Collection 1.0.0
Breadcrumbs::render() string 2.2.0
Breadcrumbs::render(string $name) string 1.0.0
Breadcrumbs::render(string $name, mixed $param1, ...) string 1.0.0
Breadcrumbs::view(string $view) string 4.0.0
Breadcrumbs::view(string $view, string $name) string 4.0.0
Breadcrumbs::view(string $view, string $name, mixed $param1, ...) string 4.0.0
Breadcrumbs::setCurrentRoute(string $name) void 2.2.0
Breadcrumbs::setCurrentRoute(string $name, mixed $param1, ...) void 2.2.0
Breadcrumbs::clearCurrentRoute() void 2.2.0


Defining breadcrumbs

use App\Models\Post;
use DaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator;

Breadcrumbs::before(function (BreadcrumbsGenerator $trail) {
    // ...

Breadcrumbs::for('name', function (BreadcrumbsGenerator $trail, Post $post) {
    // ...

Breadcrumbs::after(function (BreadcrumbsGenerator $trail) {
    // ...
Method Returns Added in
$trail->push(string $title) void 1.0.0
$trail->push(string $title, string $url) void 1.0.0
$trail->push(string $title, string $url, array $data) void 2.3.0
$trail->parent(string $name) void 1.0.0
$trail->parent(string $name, mixed $param1, ...) void 1.0.0


In the view (template)

@foreach ($breadcrumbs as $breadcrumb)
    {{-- ... --}}
Variable Type Added in
$breadcrumb->title string 1.0.0
$breadcrumb->url string / null 1.0.0
$breadcrumb->custom_attribute_name mixed 2.3.0



Setting Type Added in
view string 2.0.0
files string / array 4.0.0
unnamed-route-exception boolean 4.0.0
missing-route-bound-breadcrumb-exception boolean 4.0.0
invalid-named-breadcrumb-exception boolean 4.0.0
manager-class string 4.2.0
generator-class string 4.2.0



Laravel Breadcrumbs uses Semantic Versioning.

v5.1.2 (Fri 14 Sep 2018)

v5.1.1 (Wed 5 Sep 2018)

  • Add Laravel 5.7 support

v5.1.0 (Sat 5 May 2018)

  • Add Breadcrumbs::for($name, $callback) as an alias for Breadcrumbs::register($name, $callback)
  • Renamed $breadcrumbs to $trail in documentation (this doesn't affect the code)

These changes were inspired by (read: taken directly from) Dwight Watson's Breadcrumbs package.

Upgrading from 5.0.0 to 5.1.0

No changes are required, but I recommend updating your routes/breadcrumbs.php to match the new documentation:

  • Replace Breadcrumbs::register with Breadcrumbs::for
  • Replace $breadcrumbs with $trail

v5.0.0 (Sat 10 Feb 2018)

  • Add Laravel 5.6 support, and drop support for Laravel 5.5
  • Drop PHP 7.0 support (add void return type hint, and use [] instead of list())
  • Fix class names in PhpDoc for Breadcrumbs facade when using IDE Helper

Upgrading from 4.x to 5.x

  • Upgrade to Laravel 5.6 (requires PHP 7.1.3+)
  • If you are extending any classes, add : void return type hints where needed.

Older versions

Technical Support

Sorry, I don't offer technical support. I spent a lot of time building Laravel Breadcrumbs and writing documentation, and I give it to you for free. Please don't expect me to also solve your problems for you.

I strongly believe that spending time fixing your own problems is the best way to learn, but if you're really stuck, I suggest you try posting a question on Stack Overflow, Forum or Laracasts Forum.

Bug Reports

Please open an issue on GitHub. But remember this is free software, so I don't guarantee to fix any bugs – I will investigate if/when I have the time and motivation to do so. Don't be afraid to go into the Laravel Breadcrumbs code (vendor/davejamesmiller/laravel-breadcrumbs/src/), use var_dump() to see what's happening and fix your own problems (and open a pull request with the fix if appropriate).


Bug fixes: Please fix it and open a pull request. Bonus points if you add a unit test to make sure it doesn't happen again!

New features: Only high value features with a clear use case and well-considered API will be accepted. They must be documented and include unit tests. I suggest you open an issue to discuss the idea first.

Documentation: If you think the documentation can be improved in any way, please do edit this file and make a pull request.

Developing inside your application

The easiest way to work on Laravel Breadcrumbs inside your existing application is to tell Composer to install from source (Git) using the --prefer-source flag:

rm -rf vendor/davejamesmiller/laravel-breadcrumbs
composer install --prefer-source


cd vendor/davejamesmiller/laravel-breadcrumbs
git checkout -t origin/master
# Make changes and commit them
git checkout -b YOUR_BRANCH
git remote add YOUR_USERNAME

Alternatively there is a test app that you can use.

Using your fork in a project

To use your own fork in a project, update the composer.json in your main project as follows:

    "repositories": [
            "type": "vcs",
            "url": ""
    "require": {
        "davejamesmiller/laravel-breadcrumbs": "dev-YOUR_BRANCH"

Replace YOUR_USERNAME with your GitHub username and YOUR_BRANCH with the branch name (e.g. develop). This tells Composer to use your repository instead of the default one.

Unit tests

To run the unit tests:


To check code coverage:


Then open test-coverage/index.html to view the results. Be aware of the edge cases in PHPUnit that can make it not-quite-accurate.

API Docs

To generate API docs using phpDocumentor:


Note: This currently fails for BreadcrumbsManager due to function for(...), even though it's valid PHP7 code.


MIT License

Copyright © 2013-2018 Dave James Miller

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.