$files->filter()
Filters elements by one of the predefined filter methods, by a custom filter function or an array of filters
$files->filter(Closure|array|string $field): Kirby\Cms\FilesParameters
| Name | Type | Default |
|---|---|---|
| $fieldrequired | Closureorarrayorstring |
no default value |
Return type
This method does not modify the existing $files object but returns a new object with the changes applied. Learn more →
Parent class
Kirby\Cms\Files
inherited from Kirby\Toolkit\Collection
Examples
// fetch files with a caption
$files = $page->files()->filter(
fn ($file) => $file->caption() != ''
);
// fetch files grouped by a gallery field
$images = $page->images()->filter(
fn ($image) => $image->gallery() == 'gallery-2'
);
// fetch large files
$largeFiles = $page->files()->filter(
fn ($file) => $file->size() > (1024*1024*2)
);