Add an `all` or `none` robots header to your requests via a middleware in Laravel
spatie/laravel-robots-middleware is a Laravel package for add an `all` or `none` robots header to your requests via a middleware in laravel.
It currently has 333 GitHub stars and 2.235.727 downloads on Packagist (latest version 1.4.2).
Install it with composer require spatie/laravel-robots-middleware.
Discover more Laravel packages by spatie
or browse all Laravel packages to compare alternatives.
Last updated
A tiny, opinionated package to enable or disable indexing your site via a middleware in Laravel.
More on the Robots meta tag: https://developers.google.com/webmasters/control-crawl-index/docs/robots_meta_tag
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
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.
You can install the package via composer:
$ composer require spatie/laravel-robots-middleware
By default, the middleware enables indexing on all pages. You'll probably want to inherit your own class containing you application's indexing rule handler.
// app/Http/Middleware/MyRobotsMiddleware.php
namespace App\Http\Middleware;
use Illuminate\Http\Request;
use Spatie\RobotsMiddleware\RobotsMiddleware;
class MyRobotsMiddleware extends RobotsMiddleware
{
/**
* @return string|bool
*/
protected function shouldIndex(Request $request)
{
return $request->segment(1) !== 'admin';
}
}
Next, simply register the newly created class in your middleware stack.
// app/Http/Kernel.php
class Kernel extends HttpKernel
{
protected $middleware = [
// ...
\App\Http\Middleware\MyRobotsMiddleware::class,
];
// ...
}
That's it! Responses will now always have an x-robots-tag in their headers, containing an all or none value.
Please see CHANGELOG for more information what has changed recently.
$ composer test
Please see CONTRIBUTING for details. Due to nature of this package, there's a fair chance features won't be accepted to keep it light and opinionated.
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
