Redirect missing pages in your Laravel application

When transitioning from a old site to a new one your URLs may change. If your old site was popular you probably want to retain your SEO worth. One way of doing this is by providing permanent redirects from your old URLs to your new URLs. This package makes that process very easy.

When installed you only need to add your redirects to the config file. Want to use the database as your source of redirects? No problem!

Installation

You can install the package via composer:

composer require spatie/laravel-missing-page-redirector

The package will automatically register itself.

Next you must register the Spatie\MissingPageRedirector\RedirectsMissingPages-middleware:

//app/Http/Kernel.php

protected $middleware = [
       ...
       \Spatie\MissingPageRedirector\RedirectsMissingPages::class,
    ],

Finally you must publish the config file:

php artisan vendor:publish --provider="Spatie\MissingPageRedirector\MissingPageRedirectorServiceProvider"

This is the contents of the published config file:

return [
    /*
     * This is the class responsible for providing the URLs which must be redirected.
     * The only requirement for the redirector is that it needs to implement the
     * `Spatie\MissingPageRedirector\Redirector\Redirector`-interface
     */
    'redirector' => \Spatie\MissingPageRedirector\Redirector\ConfigurationRedirector::class,
    
    /*
     * By default the package will only redirect 404s. If you want to redirect on other
     * response codes, just add them to the array. Leave the array empty to redirect
     * always no matter what the response code.
     */
    'redirect_status_codes' => [
        \Symfony\Component\HttpFoundation\Response::HTTP_NOT_FOUND
    ],
    
    /*
     * When using the `ConfigurationRedirector` you can specify the redirects in this array.
     * You can use Laravel's route parameters here.
     */
    'redirects' => [
//        '/non-existing-page' => '/existing-page',
//        '/old-blog/{url}' => '/new-blog/{url}',
    ],

];

Usage

Creating a redirect is easy. You just have to add an entry to the redirects key in the config file.

'redirects' => [
   '/non-existing-page' => '/existing-page',
],

You may use route parameters like you're used to when using Laravel's routes:

    'redirects' => [
       '/old-blog/{url}' => '/new-blog/{url}',
    ],

Optional parameters are also... an option:

    'redirects' => [
       '/old-blog/{url?}' => '/new-blog/{url}',
    ],

By default it only redirects if the request has a 404 response code but it's possible to be redirected on any response code. To achieve this you may change the redirect_status_codes option to an array of response codes or leave it empty if you wish to be redirected no matter what the response code was sent to the URL. You may override this using the following syntax to achieve this:

    'redirect_status_codes' => [\Symfony\Component\HttpFoundation\Response::HTTP_NOT_FOUND],

It is also possible to optionally specify which http response code is used when performing the redirect. By default the 301 Moved Permanently response code is set. You may override this using the following syntax:

    'redirects' => [
       'old-page' => ['/new-page', 302],
    ],

Events

The package will fire a RouteWasHit event when it found a redirect for the route. A RedirectNotFound is fired when no redirect was found.

Creating your own redirector

By default this package will use the Spatie\MissingPageRedirector\Redirector\ConfigurationRedirector which will get its redirects from the config file. If you want to use another source for your redirects (for example a database) you can create your own redirector.

A valid redirector is any class that implements the Spatie\MissingPageRedirector\Redirector\Redirector-interface. That interface looks like this:

namespace Spatie\MissingPageRedirector\Redirector;

use Symfony\Component\HttpFoundation\Request;

interface Redirector
{
    public function getRedirectsFor(Request $request): array;
}

The getRedirectsFor method should return an array in which the keys are the old URLs and the values the new URLs.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

• Freek Van der Herten
• All Contributors

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

License

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