spatie/laravel-missing-page-redirector

Redirect missing pages in your Laravel application

2.10.0 2024-03-12 16:18 UTC

Requires

• php: ^8.0|^8.1
• laravel/framework: ^8.28|^9.0|^10.0|^11.0
• spatie/url: ^1.0|^2.0

Requires (Dev)

• orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
• pestphp/pest: ^1.22|^2.34
• phpunit/phpunit: ^9.0|^9.3|^10.5

MIT

• Freek Van der Herten

• spatie
• laravel-missing-page-redirector

README

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!

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/laravel-missing-page-redirector

The package will automatically register itself.

Next, prepend/append the Spatie\MissingPageRedirector\RedirectsMissingPages middleware to your global middleware stack:

// bootstrap/app.php
->withMiddleware(function (Middleware $middleware) {
    $middleware->append([
        \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}',
    ],

Finally, you can use an asterix (*) as a wildcard parameter that will match multiple URL segments (see encoded URL slashes in the Laravel docs for more info). This is useful when you want to redirect a URL like /old-blog/foo/bar/baz to /new-blog/foo/bar/baz.

    'redirects' => [
       '/old-blog/*' => '/new-blog/{wildcard}', // {wilcard} will be the entire path
    ],

By default the package 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.

If you want to use Route::fallback

If you do not wish to overwrite the default redirector, or if you already have existing Route::fallback logic based on laravel docs, you can use this package as follow. In the bottom of your web.php file,

use Spatie\MissingPageRedirector\MissingPageRouter;
//... Your other route

Route::fallback(function (Request $request) {
    $redirectResponse = app(MissingPageRouter::class)->getRedirectFor($request);

    if ($redirectResponse !== null) {
        return $redirectResponse;
    }
    //... Your other logic
});

You can adjust the priority of redirect base on your needs.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you've found a bug regarding security please mail [e-mail] instead of using the issue tracker.

Credits

• Freek Van der Herten
• All Contributors

License

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