Get expert guidance in a few days with a Laravel code review

Laravel Global Scopes: Automatic Query Filtering

Last updated on by

Laravel Global Scopes: Automatic Query Filtering image

Global scopes provide a streamlined way to apply consistent constraints across all queries for specific Eloquent models. Laravel's soft delete feature demonstrates this concept by automatically filtering out deleted records from query results.

Define global scopes by creating classes that implement the Illuminate\Database\Eloquent\Scope interface:

<?php
 
namespace App\Models\Scopes;
 
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;
 
class ActiveScope implements Scope
{
public function apply(Builder $builder, Model $model): void
{
$builder->where('is_active', true);
}
}

Apply the scope to your model using the ScopedBy attribute to ensure all queries automatically include the constraint:

<?php
 
namespace App\Models;
 
use App\Models\Scopes\ActiveScope;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Model;
 
#[ScopedBy([ActiveScope::class])]
class Product extends Model
{
protected $fillable = ['name', 'price', 'is_active'];
}

This approach proves invaluable in multi-tenant applications where data isolation is critical. Consider a SaaS platform serving multiple organizations, where each tenant's data must remain completely separated:

<?php
 
namespace App\Models\Scopes;
 
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;
 
class TenantScope implements Scope
{
public function apply(Builder $builder, Model $model): void
{
if (auth()->check() && auth()->user()->tenant_id) {
$builder->where('tenant_id', auth()->user()->tenant_id);
}
}
}
 
class PublishedScope implements Scope
{
public function apply(Builder $builder, Model $model): void
{
$builder->where('status', 'published')
->where('published_at', '<=', now());
}
}
 
#[ScopedBy([TenantScope::class, PublishedScope::class])]
class Document extends Model
{
protected $fillable = ['title', 'content', 'status', 'tenant_id', 'published_at'];
 
protected $casts = [
'published_at' => 'datetime',
];
}
 
class DocumentController extends Controller
{
public function index()
{
$documents = Document::orderBy('published_at', 'desc')->get();
 
return view('documents.index', compact('documents'));
}
 
public function adminIndex()
{
$allDocuments = Document::withoutGlobalScopes([PublishedScope::class])
->orderBy('created_at', 'desc')
->get();
 
return view('admin.documents.index', compact('allDocuments'));
}
 
public function systemReport()
{
$systemWideDocuments = Document::withoutGlobalScopes()
->selectRaw('tenant_id, count(*) as document_count')
->groupBy('tenant_id')
->get();
 
return view('reports.system', compact('systemWideDocuments'));
}
}

Global scopes automatically enforce business rules at the model level, ensuring data consistency without requiring manual constraint application in every query. When necessary, you can bypass these constraints using withoutGlobalScope() for specific scopes or withoutGlobalScopes() to remove all applied global filters.

Harris Raftopoulos photo

Senior Software Engineer • Staff & Educator @ Laravel News • Co-organizer @ Laravel Greece Meetup

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Acquaint Softtech

Hire Laravel developers with AI expertise at $20/hr. Get started in 48 hours.

Visit Acquaint Softtech
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $3200/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Get expert guidance in a few days with a Laravel code review logo

Get expert guidance in a few days with a Laravel code review

Expert code review! Get clear, practical feedback from two Laravel devs with 10+ years of experience helping teams build better apps.

Get expert guidance in a few days with a Laravel code review
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit

The latest

View all →
FrankenPHP v1.11.2 Released With 30% Faster CGO, 40% Faster GC, and Security Patches image

FrankenPHP v1.11.2 Released With 30% Faster CGO, 40% Faster GC, and Security Patches

Read article
Capture Web Page Screenshots in Laravel with Spatie's Laravel Screenshot image

Capture Web Page Screenshots in Laravel with Spatie's Laravel Screenshot

Read article
Nimbus: An In-Browser API Testing Playground for Laravel image

Nimbus: An In-Browser API Testing Playground for Laravel

Read article
Laravel 12.51.0 Adds afterSending Callbacks, Validator whenFails, and MySQL Timeout image

Laravel 12.51.0 Adds afterSending Callbacks, Validator whenFails, and MySQL Timeout

Read article
Handling Large Datasets with Pagination and Cursors in Laravel MongoDB image

Handling Large Datasets with Pagination and Cursors in Laravel MongoDB

Read article
Driver-Based Architecture in Spatie's Laravel PDF v2 image

Driver-Based Architecture in Spatie's Laravel PDF v2

Read article