How do I use Laravel Query Global Scopes

Question

I am implementing Laravel Global Scope as documented here but this seems to be not working for me. Below is my line of code in User.php model

<?php

namespace App;

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

class User extends Model
{
    /**
     * The "booted" method of the model.
     *
     * @return void
     */
    protected static function booted()
    {
        static::addGlobalScope('age', function (Builder $builder) {
            $builder->where('age', '>' , 100);
        });
    }
}

and when I fired User::all() it only gives me user query as select * from users

Please let me know if I am doing something wrong or missing something here...

is `User` referring to `App\User` where you are using `User::all()`? — lagbox, Jul 17 '20 at 04:27
Yes. The Eloquent returns data but does not add that where condition — Abhi Burk, Jul 17 '20 at 04:29
Are you by any chance using Tinker? If you are, and you've saved the file (`User.php`) after opening a Tinker session, you need to exit it first and start it again. By Tinker I mean `php artisan tinker`. — Amir Asyraf, Jul 17 '20 at 06:08
You have to call `parent::boot()` at the beginning of the method. — Michael, Jul 17 '20 at 08:59
@AmirAsyraf Nope I have not used any Tinker. It is just normal route controller call — Abhi Burk, Jul 17 '20 at 10:03
@Michael I tried that as well even though it was not mentioned in the Laravel Docs. — Abhi Burk, Jul 17 '20 at 10:04
Make `tests` table and `Test` model to try with new entity for sake of check does it work that way. — Tpojka, Jul 18 '20 at 16:45
@Tpojka Nope I tried on another model and did `Post::all()` but still it gave `select * from posts` — Abhi Burk, Jul 18 '20 at 16:50
Yes it does work but then I have to apply it for every query and I dont want that — Abhi Burk, Jul 18 '20 at 16:52
Let us [continue this discussion in chat](https://chat.stackoverflow.com/rooms/218101/discussion-between-tpojka-and-abhi-burk). — Tpojka, Jul 18 '20 at 16:53

Abhi Burk · Accepted Answer · 2020-08-02T09:56:27.383

4

I finally found what mistake I was making. If someone does the same please check the below details.

As mentioned in the question I am using Laravel 6.x but I was refering Laravel 7.x which has very much difference. In Laravel 6.x we use

protected static function boot(){
   parent::boot();
   static::addGlobalScope(new BlockedUserScope);
}

and in Laravel 7.x we use

protected static function booted(){
   static::addGlobalScope(new BlockedUserScope);
}

edited Aug 02 '20 at 09:56

answered Jul 18 '20 at 17:41

Abhi Burk

2,003
1
14
21

Yeah and I was trying the latest one on Laravel 6.x – Abhi Burk Jul 19 '20 at 14:16
Why? Where is it documented? I've been struggling to find the right way how to do this in L8. Boot or booted? – Jakub Feb 07 '21 at 15:25
L 6.x has `boot` - https://laravel.com/docs/6.x/eloquent#global-scopes and L 7.x or > has `booted` - https://laravel.com/docs/7.x/eloquent#global-scopes – Abhi Burk Feb 15 '21 at 12:17

score 2 · Answer 2 · answered Mar 31 '22 at 09:13

in Laravel 8.x we use

protected static function booted()
{
    static::addGlobalScope(function ($query) {
        $query
            ->join('model_has_roles', function ($join) {
                $join->on('model_id', '=', 'users.id')
                    ->where('model_type', '=', 'App\Models\User');
            })
            ->join('roles', function ($join) {
                $join->on('role_id', '=', 'roles.id')
                    ->where('roles.name', '=', 'visitor');
            })
            ->select('users.*');
    });
}

score 1 · Answer 3 · answered Apr 30 '23 at 20:56

In Laravel 8's Illuminate\Database\Eloquent\Model,
I can see 3 calls, wihtout anything in between, like:

static::booting();
static::boot();
static::booted();

Meaning placing our logic at end of boot() method is same for all versions.

Hence, no matter what Laravel version, try something like:

protected static function boot(){
    parent::boot();
    static::addGlobalScope(new BlockedUserScope);
}

How do I use Laravel Query Global Scopes

3 Answers3