Eloquent query scope improves code reusability and readability by encapsulating common query conditions, and is divided into local scope and global scope. 1. The local scope is defined in the model and implemented with methods starting with scope. For example, scopeActive() is used to filter and activate users. User::active()->get() is directly used when calling. It supports queries with parameters, such as scopeRole($query, $role) can be used through User::role('admin')->get(). 2. Global scope automatically applies unified filtering rules in all queries by implementing the Scope interface and overwriting the apply method. For example, if the default query user with status active by querying by default, addGlobalScope needs to be registered in the model, or temporarily removed through withoutGlobalScopes(). When using it, you should avoid complex logic, clear naming, and reasonable use of global scope, and ensure effectiveness through testing.

Using Eloquent Query Scopes in Laravel allows you to reuse query logic more gracefully. It is not a master skill, but it can make the code clearer and easier to maintain if used properly.

What is Eloquent query scope?

Eloquent's query scope is essentially an encapsulated query condition that can be attached to the model's query. You can understand it as a "preset filter". For example, you often need to find out all enabled users and write this condition into a scope.

There are two types of query scopes:

• Local Scopes : Methods starting with scope can be defined in the model.
• Global Scopes : Implement Illuminate\Database\Eloquent\Scope interface, suitable for all queries in the entire model.

How to define and use local query scope?

This is the most common and easiest way to get started. For example, if you want to filter out all "activated" users, you can write it like this in the User model:

 public function scopeActive($query)
{
    return $query->where('status', 'active');
}

Then when calling:

 User::active()->get();

You can combine multiple scopes, such as:

 User::active()->verified()->orderBy('created_at')->get();

The benefits of this approach are intuitive, readable, and do not require repeating the same where conditions every time.

Tip: If your scope requires parameters, such as filtering users based on roles, you can also add parameters:

 public function scopeRole($query, $role)
{
    return $query->where('role', $role);
}

When using the parameters:

 User::role('admin')->get();

Global scope is more suitable for unified filtering rules

If you want certain query conditions to be automatically applied to all queries, such as deleted_at IS NULL in the soft delete mechanism, you can use the global scope.

Creating a global scope requires implementing the Scope interface and overriding the apply method. For example, we want to only display users whose status is active by default:

 use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class ActiveUserScope implements Scope
{
    public function apply(Builder $builder, Model $model)
    {
        $builder->where('status', 'active');
    }
}

Then register this scope in the model:

 use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    protected static function booted()
    {
        static::addGlobalScope(new ActiveUserScope());
    }
}

In this way, every time the User model is queryed where status = 'active' will be automatically added.

Note: If you want to temporarily remove the global scope, you can use:

 User::withoutGlobalScopes()->get();

---

Common misunderstandings and precautions

• Don't put all complex logic into scope : scope is suitable for the conditional splicing of a single responsibility. It is recommended to extract the logic that is too complex and put it in the Repository or Service layer.
• The naming should be clear and concise : for example, scopeVerified() is obviously easier to understand than scopeCheckIfEmailConfirmed() .
• Avoid overuse of global scope : Although it is convenient, it may make it difficult for novices to see why the data is low, which makes it difficult to debug.
• Remember to test whether the scope is effective : especially when multiple scopes are nested or combined, unit testing can help you avoid many hidden problems.

---

Basically that's it. Query scope is not a must-have feature, but using it in the right place will make your code look more professional and tidy.

The above is the detailed content of Working with Eloquent Query Scopes in Laravel?. For more information, please follow other related articles on the PHP Chinese website!