[9.x] Adds Eloquent User Provider query handler

src/Illuminate/Auth/EloquentUserProvider.php

@@ -24,6 +24,13 @@ class EloquentUserProvider implements UserProvider
      */
     protected $model;
 
+    /**
+     * The callback that may modify the user retrieval queries.
+     *
+     * @var (\Closure(\Illuminate\Database\Eloquent\Builder):mixed)|null
+     */
+    protected $queryCallback;
+
     /**
      * Create a new database user provider.
      *
@@ -155,9 +162,13 @@ public function validateCredentials(UserContract $user, array $credentials)
      */
     protected function newModelQuery($model = null)
     {
-        return is_null($model)
+        $query = is_null($model)
                 ? $this->createModel()->newQuery()
                 : $model->newQuery();
+
+        with($query, $this->queryCallback);
+
+        return $query;
     }
 
     /**
@@ -217,4 +228,27 @@ public function setModel($model)
 
         return $this;
     }
+
+    /**
+     * Get the callback that modifies the query before retrieving users.
+     *
+     * @return \Closure|null
+     */
+    public function getQueryCallback()
+    {
+        return $this->queryCallback;
+    }
+
+    /**
+     * Sets the callback to modify the query before retrieving users.
+     *
+     * @param  (\Closure(\Illuminate\Database\Eloquent\Builder):mixed)|null  $queryCallback
+     * @return $this
+     */
+    public function withQuery($queryCallback = null)
+    {
+        $this->queryCallback = $queryCallback;
+
+        return $this;
+    }
 }

tests/Auth/AuthEloquentUserProviderTest.php

@@ -149,6 +149,28 @@ public function testModelsCanBeCreated()
         $this->assertInstanceOf(EloquentProviderUserStub::class, $model);
     }
 
+    public function testRegistersQueryHandler()
+    {
+        $callback = function ($builder) {
+            $builder->whereIn('group', ['one', 'two']);
+        };
+
+        $provider = $this->getProviderMock();
+        $mock = m::mock(stdClass::class);
+        $mock->shouldReceive('newQuery')->once()->andReturn($mock);
+        $mock->shouldReceive('where')->once()->with('username', 'dayle');
+        $mock->shouldReceive('whereIn')->once()->with('group', ['one', 'two']);
+        $mock->shouldReceive('first')->once()->andReturn('bar');
+        $provider->expects($this->once())->method('createModel')->willReturn($mock);
+        $provider->withQuery($callback);
+        $user = $provider->retrieveByCredentials([function ($builder) {
+            $builder->where('username', 'dayle');
+        }]);
+
+        $this->assertSame('bar', $user);
+        $this->assertSame($callback, $provider->getQueryCallback());
+    }
+
     protected function getProviderMock()
     {
         $hasher = m::mock(Hasher::class);