[5.x] Add hook to query on entries listing (#10479)

Co-authored-by: duncanmcclean <[email protected]>
Co-authored-by: Jason Varga <[email protected]>

src/Hooks/CP/EntriesIndexQuery.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Statamic\Hooks\CP;
+
+use Statamic\Support\Traits\Hookable;
+
+class EntriesIndexQuery
+{
+    use Hookable;
+
+    public function __construct(private $query, private $collection)
+    {
+        //
+    }
+
+    public function paginate(?int $perPage)
+    {
+        $payload = $this->runHooksWith('query', [
+            'query' => $this->query,
+            'collection' => $this->collection,
+        ]);
+
+        return $payload->query->paginate($perPage);
+    }
+}

src/Hooks/Payload.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Statamic\Hooks;
+
+class Payload
+{
+    public function __construct(private array $payload)
+    {
+        //
+    }
+
+    public function __get($key)
+    {
+        return $this->payload[$key] ?? null;
+    }
+
+    public function __set($key, $value)
+    {
+        $this->payload[$key] = $value;
+    }
+}

src/Http/Controllers/CP/Collections/EntriesController.php

@@ -13,6 +13,7 @@
 use Statamic\Facades\Site;
 use Statamic\Facades\Stache;
 use Statamic\Facades\User;
+use Statamic\Hooks\CP\EntriesIndexQuery;
 use Statamic\Http\Controllers\CP\CpController;
 use Statamic\Http\Requests\FilteredRequest;
 use Statamic\Http\Resources\CP\Entries\Entries;
@@ -49,7 +50,7 @@ public function index(FilteredRequest $request, $collection)
             $query->orderBy($sortField, $sortDirection);
         }
 
-        $entries = $query->paginate(request('perPage'));
+        $entries = (new EntriesIndexQuery($query, $collection))->paginate(request('perPage'));
 
         if (request('search') && $collection->hasSearchIndex()) {
             $entries->setCollection($entries->getCollection()->map->getSearchable());

src/Support/Traits/Hookable.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Illuminate\Pipeline\Pipeline;
+use Statamic\Hooks\Payload;
 
 trait Hookable
 {
@@ -46,4 +47,9 @@ protected function runHooks(string $name, $payload = null)
             ->through($closures->all())
             ->thenReturn();
     }
+
+    protected function runHooksWith(string $name, array $payload)
+    {
+        return $this->runHooks($name, new Payload($payload));
+    }
 }