stevecreekmore/laravel-block

A User can block another User

v1.0.0 2025-10-03 17:56 UTC

Requires

• php: ^8.1

Requires (Dev)

• php: ^8.1
• orchestra/testbench: ~7
• phpunit/phpunit: ~9.0

MIT

• Steven Creekmore

• laravel
• Block users
• Laravel Block

README

A simple Laravel package for blocking users.

Requirements

• Laravel 11 or greater.
• Laravel User model.

Installation

Via Composer

$ composer require stevecreekmore/laravel-block

Import Laravel Block into your User model and add the trait.

namespace App\Models;

use stevecreekmore\LaravelBlock\LaravelBlock;

class User extends Authenticatable
{
    use LaravelBlock;
}

Then run migrations.

php artisan migrate

Usage

Block a user.

auth()->user()->block($user);

Unblock a user.

auth()->user()->unblock($user);

Check if a user is blocking another user.

@if (auth()->user()->isBlocking($user))
    You are blocking this user.
@endif

Check if a user is blocked by another user.

@if (auth()->user()->isBlockedBy($user))
    This user is blocking you.
@endif

Returns the users a user is blocking.

auth()->user()->getBlocking();

Returns the users who are blocking a user.

auth()->user()->getBlockers();

Returns an array of IDs of the users a user is blocking.

auth()->user()->getBlockingIds();

Returns an array of IDs of the users who are blocking a user.

auth()->user()->getBlockersIds();

Returns an array of IDs of the users a user is blocking, and who is blocking a user

auth()->user()->getBlockingAndBlockersIds()

Testing

$ composer test

License

MIT. Please see the license file for more information.