---
title: "Collection Filter"
canonical: "https://support.appfire.com/space/REPS/472914738/Collection%20Filter"
format: markdown
---
> Macro (aura-html)

### Description

Checks that any contained filter values exist on all/any/none of the items in the collection specified by the filter's **prefix:key** value.

This macro must be used within a reporter macro.

### Parameters

| Name | Required | Migratable to Cloud? | Default Value | Description |
| --- | --- | --- | --- | --- |
| [default] /key | - (/) | - NO |  | The key value to filter on. |
| matchItems | - (/) | - NO | all | Define how many of the collection's items can match the sub-filters. May be one of the following:<br>- **all** - (default) All items must match the sub-filter set.
- **any** - At least one item must match the sub-filter set.
- **none** - None of the items may match the sub-filter set. |
| matchFilters | - (/) | - NO | all | Define how many of the sub-filters must match for the item to be let through. May be one of the following:<br>- **all** - (default) All sub-filters must match the item.
- **any** - At least one sub-filter must match the item.
- **none** - None of the sub-filters may match item. |

### Editor View

![image](media://fa8089b3-5ee8-4f32-9d89-c4fae9ecdcef)



### Macro Edit View

- Not applicable.

### Notes

#### Nesting Collection Filters

You can use '{collection-filter-1}' to '{collection-filter-5}' if you need to nest collection filters.

##### Filter on page children

Display pages with at least one child with a title that starts with 'Foo'.

```
{report-list}
  {local-reporter:content:children}
    {text-sort:content:title}
    {collection-filter:content:children|matchItems=any}
      {text-filter:content:title|include=Foo.*}
    {collection-filter}
  {local-reporter}
  {report-body}
    {report-info:content:title|link=true}
  {report-body}
{report-list}
```

##### Filter on Scaffolding data

Display pages which have a Table Data (from Scaffolding) section which contains a row which has a number field value between 1 and 5.

```
{local-reporter:content:children}  
  {text-sort:content:title}  
  {collection-filter:data:Table|matchItems=any}    
    {number-filter:data:Number|minValue=1|maxValue=5}  
  {collection-filter}
{local-reporter}
```


# Tutorial Examples

> Macro (contentbylabel)