Skip to content

[5.x] Make GetItemsContainingData hookable #13302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasonvarga merged 2 commits into from
Dec 11, 2025
Merged

[5.x] Make GetItemsContainingData hookable #13302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5bd2f1
Make GetItemsContainingData hookable
ryanmitchell Dec 10, 2025
e2d18a4
fix failing test
ryanmitchell Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Listeners/Concerns/GetsItemsContainingData.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@
use Statamic\Facades\GlobalSet;
use Statamic\Facades\Term;
use Statamic\Facades\User;
use Statamic\Support\Traits\Hookable;

trait GetsItemsContainingData
{
use Hookable;

/**
* Get items containing data.
*
Expand All @@ -30,6 +33,9 @@ public function getItemsContainingData()
LazyCollection::make(function () {
yield from User::query()->lazy();
}),
LazyCollection::make(function () {
yield from ($this->runHooks('additional') ?? LazyCollection::make());
}),
];

return LazyCollection::make(function () use ($collections) {
Expand Down
15 changes: 15 additions & 0 deletions tests/Listeners/UpdateAssetReferencesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@

use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\LazyCollection;
use Orchestra\Testbench\Attributes\DefineEnvironment;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\AssetFolder;
use Statamic\Facades;
use Statamic\Listeners\UpdateAssetReferences;
use Statamic\Support\Arr;
use Tests\PreventSavingStacheItemsToDisk;
use Tests\TestCase;
Expand Down Expand Up @@ -1852,6 +1854,19 @@ public function it_only_saves_items_when_there_is_something_to_update()
$this->assetHoff->path('hoff-new.jpg')->save();
}

#[Test]
public function it_gets_items_from_a_hook()
{
UpdateAssetReferences::hook('additional', function () {
return LazyCollection::make(['additional-1', 'additional-2']);
});

$items = ((new UpdateAssetReferences)->getItemsContainingData())->all();

$this->assertContains('additional-1', $items);
$this->assertContains('additional-2', $items);
}

protected function setSingleBlueprint($namespace, $blueprintContents)
{
$blueprint = tap(Facades\Blueprint::make('single-blueprint')->setContents($blueprintContents))->save();
Expand Down