$files->filter()

Filters elements by a custom filter function or an array of filters

$files->filter(array|\Closure $filter): Kirby\Cms\Files

Parameters

Name	Type	Default	Description
`$filter`	`array`\|`Closure`	–

Return type

Kirby\Cms\Files

Exceptions

Type	Description
`Exception`	if $filter is neither a closure nor an array

Example

// fetch files with a caption
$files = $page->files()->filter(function($file) {
  return $file->caption() != '';
});

// fetch files grouped by a gallery field
$images = $page->images()->filter(function($image) {
  return $image->gallery() == 'gallery-2';
});

// fetch large files
$largeFiles = $page->files()->filter(function($file) {
  return $file->size() > (1024*1024*2);
});

More information

Filtering compendium

Inherited from

Kirby\Toolkit\Collection

Source code

kirby/src/Toolkit/Collection.php#L247