Middleware groups in Laravel

Introduction

Middleware groups help you organize multiple middleware into one set. This makes it easy to apply many middleware at once to routes.

You want to apply authentication and logging middleware together to many routes.

You have a set of middleware for web pages and another set for API routes.

You want to keep your route files clean by grouping middleware logically.

You need to reuse the same middleware stack in different parts of your app.

Syntax

Laravel

protected $middlewareGroups = [
    'groupName' => [
        MiddlewareClass1::class,
        MiddlewareClass2::class,
        // more middleware
    ],
];

Middleware groups are defined in the app/Http/Kernel.php file.

You use the group name in your routes to apply all middleware in that group at once.

Examples

This example shows the default 'web' middleware group with cookie encryption, session start, and CSRF protection.

Laravel

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
    ],
];

This example shows the 'api' group with rate limiting and route model binding middleware.

Laravel

protected $middlewareGroups = [
    'api' => [
        'throttle:60,1',
        'bindings',
    ],
];

Sample Program

This example defines a middleware group named 'customGroup' with two middleware: CheckAge and LogAccess. Then it applies this group to a route. When visiting '/dashboard', both middleware run before showing the message.

Laravel

<?php

namespace App\Http;

use Illuminate\Foundation\Http\Kernel as HttpKernel;
use App\Http\Middleware\CheckAge;
use App\Http\Middleware\LogAccess;

class Kernel extends HttpKernel
{
    protected $middlewareGroups = [
        'customGroup' => [
            CheckAge::class,
            LogAccess::class,
        ],
    ];
}

// In routes/web.php

use Illuminate\Support\Facades\Route;

Route::middleware(['customGroup'])->group(function () {
    Route::get('/dashboard', function () {
        return 'Welcome to dashboard';
    });
});

Important Notes

Middleware groups simplify applying many middleware to routes.

You can add parameters to middleware inside groups like 'throttle:60,1'.

Always define middleware classes before adding them to groups.

Summary

Middleware groups bundle multiple middleware under one name.

They are defined in app/Http/Kernel.php inside the $middlewareGroups array.

Use the group name in routes to apply all middleware in that group easily.

Practice

1. What is the main purpose of middleware groups in Laravel?

easy

A. To bundle multiple middleware under one name for easy use

B. To create database migrations automatically

C. To define routes in a separate file

D. To handle user authentication only

Solution

1. Step 1: Understand middleware groups concept

   Middleware groups combine several middleware into one named group.

2. Step 2: Identify the purpose of grouping

   This grouping allows applying multiple middleware easily by referencing the group name in routes.

3. Final Answer:

   To bundle multiple middleware under one name for easy use -> Option A

4. Quick Check:

   Middleware groups = bundle middleware [OK]

Hint: Middleware groups bundle middleware for simpler route use [OK]

Common Mistakes:

• Confusing middleware groups with route definitions
• Thinking middleware groups create migrations
• Assuming middleware groups only handle authentication

2. Which file in a Laravel project defines middleware groups?

easy

A. routes/web.php

B. app/Http/Kernel.php

C. config/app.php

D. app/Providers/RouteServiceProvider.php

Solution

1. Step 1: Recall where middleware is registered

   Middleware and middleware groups are registered in the Kernel class.

2. Step 2: Identify the Kernel file location

   In Laravel, this is app/Http/Kernel.php.

3. Final Answer:

   app/Http/Kernel.php -> Option B

4. Quick Check:

   Middleware groups in Kernel.php [OK]

Hint: Middleware groups live in Kernel.php file [OK]

Common Mistakes:

• Choosing route files instead of Kernel.php
• Confusing config files with middleware registration
• Selecting service providers incorrectly

3. Given this Kernel.php snippet:

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
    ],
];

What happens when you apply the 'web' middleware group to a route?

medium

A. Both EncryptCookies and VerifyCsrfToken middleware run

B. Only VerifyCsrfToken middleware runs

C. No middleware runs because groups are ignored

D. Only EncryptCookies middleware runs

Solution

1. Step 1: Examine the 'web' middleware group contents

   The 'web' group contains two middleware classes: EncryptCookies and VerifyCsrfToken.

2. Step 2: Understand group application effect

   Applying the 'web' group runs all middleware listed inside it.

3. Final Answer:

   Both EncryptCookies and VerifyCsrfToken middleware run -> Option A

4. Quick Check:

   Middleware group runs all its middleware [OK]

Hint: Middleware group runs all middleware inside it [OK]

Common Mistakes:

• Thinking only one middleware runs per group
• Assuming groups are ignored in routes
• Confusing middleware with route middleware

4. You added a new middleware to a group in Kernel.php but it does not run on routes using that group. What is a likely cause?

medium

A. You forgot to register the middleware class in the group array

B. Middleware groups cannot be modified after Laravel installation

C. Middleware groups only work with API routes

D. You did not clear the route cache after changes

Solution

1. Step 1: Understand middleware group modification

   Adding middleware to a group requires updating the Kernel.php file correctly.

2. Step 2: Recognize caching impact

   Laravel caches routes and middleware; changes require clearing cache to take effect.

3. Final Answer:

   You did not clear the route cache after changes -> Option D

4. Quick Check:

   Clear cache after middleware changes [OK]

Hint: Clear route cache after changing middleware groups [OK]

Common Mistakes:

• Assuming middleware groups are immutable
• Forgetting to clear cache after edits
• Thinking middleware groups only apply to API routes

5. You want to create a new middleware group called admin that includes the auth middleware and a custom CheckAdmin middleware. How should you define it in Kernel.php?

hard

A. 'admin' => [\App\Http\Middleware\Auth::class, 'CheckAdmin'],

B. 'admin' => ['auth', 'CheckAdmin'],

C. 'admin' => ['auth', \App\Http\Middleware\CheckAdmin::class],

D. 'admin' => [\App\Http\Middleware\auth::class, \App\Http\Middleware\CheckAdmin::class],

Solution

1. Step 1: Identify correct middleware references

   Middleware classes must be referenced by their full class name with namespace or by middleware alias strings registered in Kernel.

2. Step 2: Use middleware alias for 'auth' and class for custom middleware

   'auth' is usually an alias, so it can be a string. Custom middleware must be referenced by full class name.

3. Final Answer:

   'admin' => ['auth', \App\Http\Middleware\CheckAdmin::class], -> Option C

4. Quick Check:

   Use alias for built-in, class for custom middleware [OK]

Hint: Use alias strings for built-in, full class for custom middleware [OK]

Common Mistakes:

• Using lowercase class names incorrectly
• Using strings for custom middleware without alias
• Mixing alias and class references wrongly