Laravel Ban – Ban/unban users from your application

Projects Inventory

2 months ago

Laravel Ban is a package that allows you to easily ban and unban users in your Laravel application. This can be particularly useful for applications where you need to manage user access and enforce rules, such as forums, social media platforms, or any other application that requires user moderation.

Key Features

User Banning: Easily ban users by marking them as banned in the database.

Flexible Configuration: Customize the ban behavior to suit your application’s needs.
Automatic Unbanning: Set up automatic unbanning based on time or other criteria.
Event Handling: Trigger events when a user is banned or unbanned for further customization.

Installation

You can install the package via Composer:

bash

composer require laravel/ban

1	composer require laravel/ban

Configuration

After installing the package, you may need to publish the configuration file to customize settings:

bash

php artisan vendor:publish --provider="Laravel\Ban\BanServiceProvider"

1	php artisan vendor:publish --provider="Laravel\Ban\BanServiceProvider"

This command will create a configuration file at config/ban.php, where you can configure various settings related to banning.

Basic Usage

Banning a User

To ban a user, you can use the ban method provided by the package. Here’s an example:

php

use App\Models\User;

// Find the user you want to ban
$user = User::find($userId);

// Ban the user
$user->ban();

use App\Models\User;

// Find the user you want to ban

$user = User::find($userId);

// Ban the user

$user->ban();

Unbanning a User

Unbanning a user is just as straightforward:

php

// Unban the user
$user->unban();

1 2	// Unban the user $user->unban();

Middleware Integration

You can use middleware to automatically restrict access to banned users. To create a middleware for this, you might do the following:

Create a middleware:

bash

php artisan make:middleware CheckIfBanned

1	php artisan make:middleware CheckIfBanned

In your middleware, check if the user is banned:

php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;

class CheckIfBanned
{
    public function handle(Request $request, Closure $next)
    {
        if ($request->user() && $request->user()->isBanned()) {
            // Redirect or abort if the user is banned
            return redirect('/banned');
        }

        return $next($request);
    }
}

namespace App\Http\Middleware;

use Closure;

use Illuminate\Http\Request;

class CheckIfBanned

{

public function handle(Request $request, Closure $next)

{

if ($request->user() && $request->user()->isBanned()) {

// Redirect or abort if the user is banned

return redirect('/banned');

}

return $next($request);

}

Register the middleware in app/Http/Kernel.php:

php

protected $routeMiddleware = [ // ... 'banned' => \App\Http\Middleware\CheckIfBanned::class, ];

1
2
3
4

protected $routeMiddleware = [
// ...
'banned' => \App\Http\Middleware\CheckIfBanned::class,
];
Apply the middleware to routes:

php

Route::middleware(['auth', 'banned'])->group(function () { // Protected routes here });

1
2
3

Route::middleware(['auth', 'banned'])->group(function () {
// Protected routes here
});

Events

You can hook into events provided by the package to trigger additional functionality when users are banned or unbanned. For instance, you might want to send notifications or log these actions.

Example of listening for ban events:

php

use Laravel\Ban\Events\UserBanned;
use Laravel\Ban\Events\UserUnbanned;

Event::listen(UserBanned::class, function ($event) {
    // Handle user banned logic here
});

use Laravel\Ban\Events\UserBanned;

use Laravel\Ban\Events\UserUnbanned;

Event::listen(UserBanned::class, function ($event) {

// Handle user banned logic here

});

Conclusion

Laravel Ban is a convenient package that simplifies the management of user bans in your Laravel application. With its straightforward API and flexible configuration options, you can easily enforce user policies and maintain a healthy community environment.

Key Features

Installation

Configuration

Basic Usage

Banning a User

Unbanning a User

Middleware Integration

Events

Conclusion

Related Posts: