Skip to content

View matcher reference

You can use the following matchers to match content views:

Identifier Matches
Id\Content ID number of the Content item.
Id\ContentType ID number of the Content Type that the Content item belongs to.
Identifier\ContentType Identifier of the Content Type that the Content item belongs to.
Id\ContentTypeGroup ID number of the group containing the Content Type that the Content item belongs to.
Id\Location ID number of a Location.
Id\LocationRemote Remote ID number of a Location.
Id\ParentContentType ID number of the parent Content Type.
Identifier\ParentContentType Identifier of the parent Content Type.
Id\ParentLocation ID number of the parent Location.
Id\Remote Remote ID of a Content item.
Id\Section ID number of the Section that the Content item belongs to.
Identifier\Section Identifier of the Section that the Content item belongs to.
Depth Depth of the Location. The depth of a top level Location is 1.
UrlAlias Virtual URL of the Location.

Tip

Each matcher has a scalar value or an array of scalar values. When an array is passed, it matches on one of its values.

You can also create custom view matchers.

Id\Content

Matches the ID number of a Content item.

1
2
match:
    Id\Content: 145

Id\ContentType

Matches the ID number of a Content Type that the Content item belongs to.

1
2
match:
    Id\ContentType: 2

Identifier\ContentType

Matches the identifier of the Content Type that the Content item belongs to.

1
2
match:
    Identifier\ContentType: [blog_post]

Id\ContentTypeGroup

Matches the ID number of the Content Type Group that the Content item belongs to.

1
2
match:
    Id\ContentTypeGroup: 1

Id\Location

Matches the ID number of a Location. In the case of a Content item, matched against the main Location.

1
2
match:
    Id\Location: 144

Id\LocationRemote

Matches the Remote ID number of a Location. In the case of a Content item, matched against the main Location.

1
2
match:
    Id\LocationRemote: 5b1e33529082b68ad3a41b9089136a0a

Id\ParentContentType

Matches the ID number of the parent Content Type. In the case of a Content item, matched against the main Location.

1
2
match:
    Id\ParentContentType: 42

Identifier\ParentContentType

Matches the identifier of the parent Content Type. In the case of a Content item, matched against the main Location.

1
2
match:
    Identifier\ParentContentType: blog

Id\ParentLocation

Matches the ID number of the parent Location. In the case of a Content item, matched against the main Location.

1
2
match:
    Id\ParentLocation: 2

Id\Remote

Matches the remote ID number of a Content item.

1
2
match:
    Id\Remote: 145

Id\Section

Matches the ID number of the Section that the Content item belongs to.

1
2
match:
    Id\Section: 1

Identifier\Section

Matches the identifier of the Section that the Content item belongs to.

1
2
match:
    Identifier\Section: standard

Depth

Matches the depth of the Location. The depth of a top level Location is 1.

1
2
match:
    Depth: 2

UrlAlias

Matches the virtual URL of the Location. Matches when the URL alias of the Location starts with the value passed.

1
2
match:
    UrlAlias: 'terms-and-conditions'