Tag Queries

You can fetch tags in your templates or PHP code using tag queries.

::: code

{# Create a new tag query #}
{% set myTagQuery = craft.tags() %}

// Create a new tag query
$myTagQuery = \craft\elements\Tag::find();

:::

Once you’ve created a tag query, you can set parameters on it to narrow down the results, and then execute it by calling .all(). An array of Tag objects will be returned.

::: tip See Introduction to Element Queries to learn about how element queries work. :::

Example

We can display a list of the tags in a “Blog Tags” tag group by doing the following:

Create a tag query with craft.tags().
Set the group parameter on it.
Fetch the tags with .all().
Loop through the tags using a for tag to create the list HTML.

{# Create a tag query with the 'group' parameter #}
{% set myTagQuery = craft.tags()
    .group('blogTags') %}

{# Fetch the tags #}
{% set tags = myTagQuery.all() %}

{# Display the tag list #}
<ul>
    {% for tag in tags %}
        <li><a href="{{ url('blog/tags/'~tag.id) }}">{{ tag.title }}</a></li>
    {% endfor %}
</ul>

Parameters

Tag queries support the following parameters:

Param	Description
anyStatus	Clears out the status() and enabledForSite() parameters.
asArray	Causes the query to return matching tags as arrays of data, rather than Tag objects.
clearCachedResult	Clears the cached result.
dateCreated	Narrows the query results based on the tags’ creation dates.
dateUpdated	Narrows the query results based on the tags’ last-updated dates.
fixedOrder	Causes the query results to be returned in the order specified by id.
group	Narrows the query results based on the tag groups the tags belong to.
groupId	Narrows the query results based on the tag groups the tags belong to, per the groups’ IDs.
id	Narrows the query results based on the tags’ IDs.
ignorePlaceholders	Causes the query to return matching tags as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement().
inReverse	Causes the query results to be returned in reverse order.
limit	Determines the number of tags that should be returned.
offset	Determines how many tags should be skipped in the results.
orderBy	Determines the order that the tags should be returned in. (If empty, defaults to `title ASC`.)
preferSites	If unique is set, this determines which site should be selected when querying multi-site elements.
relatedTo	Narrows the query results to only tags that are related to certain other elements.
search	Narrows the query results to only tags that match a search query.
site	Determines which site(s) the tags should be queried in.
siteId	Determines which site(s) the tags should be queried in, per the site’s ID.
title	Narrows the query results based on the tags’ titles.
trashed	Narrows the query results to only tags that have been soft-deleted.
uid	Narrows the query results based on the tags’ UIDs.
unique	Determines whether only elements with unique IDs should be returned by the query.
uri	Narrows the query results based on the tags’ URIs.
with	Causes the query to return matching tags eager-loaded with related elements.

`anyStatus`

Clears out the status() and enabledForSite() parameters.

::: code

{# Fetch all tags, regardless of status #}
{% set tags = craft.tags()
    .anyStatus()
    .all() %}

// Fetch all tags, regardless of status
$tags = \craft\elements\Tag::find()
    ->anyStatus()
    ->all();

:::

`asArray`

Causes the query to return matching tags as arrays of data, rather than Tag objects.

::: code

{# Fetch tags as arrays #}
{% set tags = craft.tags()
    .asArray()
    .all() %}

// Fetch tags as arrays
$tags = \craft\elements\Tag::find()
    ->asArray()
    ->all();

:::

`clearCachedResult`

Clears the cached result.

`dateCreated`

Narrows the query results based on the tags’ creation dates.

Possible values include:

Value	Fetches tags…
`'>= 2018-04-01'`	that were created on or after 2018-04-01.
`'< 2018-05-01'`	that were created before 2018-05-01
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were created between 2018-04-01 and 2018-05-01.

::: code

{# Fetch tags created last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

{% set tags = craft.tags()
    .dateCreated(['and', ">= #{start}", "< #{end}"])
    .all() %}

// Fetch tags created last month
$start = (new \DateTime('first day of last month'))->format(\DateTime::ATOM);
$end = (new \DateTime('first day of this month'))->format(\DateTime::ATOM);

$tags = \craft\elements\Tag::find()
    ->dateCreated(['and', ">= {$start}", "< {$end}"])
    ->all();

:::

`dateUpdated`

Narrows the query results based on the tags’ last-updated dates.

Possible values include:

Value	Fetches tags…
`'>= 2018-04-01'`	that were updated on or after 2018-04-01.
`'< 2018-05-01'`	that were updated before 2018-05-01
`['and', '>= 2018-04-04', '< 2018-05-01']`	that were updated between 2018-04-01 and 2018-05-01.

::: code

{# Fetch tags updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}

{% set tags = craft.tags()
    .dateUpdated(">= #{lastWeek}")
    .all() %}

// Fetch tags updated in the last week
$lastWeek = (new \DateTime('1 week ago'))->format(\DateTime::ATOM);

$tags = \craft\elements\Tag::find()
    ->dateUpdated(">= {$lastWeek}")
    ->all();

:::

`fixedOrder`

Causes the query results to be returned in the order specified by id.

::: code

{# Fetch tags in a specific order #}
{% set tags = craft.tags()
    .id([1, 2, 3, 4, 5])
    .fixedOrder()
    .all() %}

// Fetch tags in a specific order
$tags = \craft\elements\Tag::find()
    ->id([1, 2, 3, 4, 5])
    ->fixedOrder()
    ->all();

:::

`group`

Narrows the query results based on the tag groups the tags belong to.

Possible values include:

Value	Fetches tags…
`'foo'`	in a group with a handle of `foo`.
`'not foo'`	not in a group with a handle of `foo`.
`['foo', 'bar']`	in a group with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not in a group with a handle of `foo` or `bar`.
a TagGroup object	in a group represented by the object.

::: code

{# Fetch tags in the Foo group #}
{% set tags = craft.tags()
    .group('foo')
    .all() %}

// Fetch tags in the Foo group
$tags = \craft\elements\Tag::find()
    ->group('foo')
    ->all();

:::

`groupId`

Narrows the query results based on the tag groups the tags belong to, per the groups’ IDs.

Possible values include:

Value	Fetches tags…
`1`	in a group with an ID of 1.
`'not 1'`	not in a group with an ID of 1.
`[1, 2]`	in a group with an ID of 1 or 2.
`['not', 1, 2]`	not in a group with an ID of 1 or 2.

::: code

{# Fetch tags in the group with an ID of 1 #}
{% set tags = craft.tags()
    .groupId(1)
    .all() %}

// Fetch tags in the group with an ID of 1
$tags = \craft\elements\Tag::find()
    ->groupId(1)
    ->all();

:::

`id`

Narrows the query results based on the tags’ IDs.

Possible values include:

Value	Fetches tags…
`1`	with an ID of 1.
`'not 1'`	not with an ID of 1.
`[1, 2]`	with an ID of 1 or 2.
`['not', 1, 2]`	not with an ID of 1 or 2.

::: code

{# Fetch the tag by its ID #}
{% set tag = craft.tags()
    .id(1)
    .one() %}

// Fetch the tag by its ID
$tag = \craft\elements\Tag::find()
    ->id(1)
    ->one();

:::

::: tip This can be combined with fixedOrder if you want the results to be returned in a specific order. :::

`ignorePlaceholders`

Causes the query to return matching tags as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement().

`inReverse`

Causes the query results to be returned in reverse order.

::: code

{# Fetch tags in reverse #}
{% set tags = craft.tags()
    .inReverse()
    .all() %}

// Fetch tags in reverse
$tags = \craft\elements\Tag::find()
    ->inReverse()
    ->all();

:::

`limit`

Determines the number of tags that should be returned.

::: code

{# Fetch up to 10 tags  #}
{% set tags = craft.tags()
    .limit(10)
    .all() %}

// Fetch up to 10 tags
$tags = \craft\elements\Tag::find()
    ->limit(10)
    ->all();

:::

`offset`

Determines how many tags should be skipped in the results.

::: code

{# Fetch all tags except for the first 3 #}
{% set tags = craft.tags()
    .offset(3)
    .all() %}

// Fetch all tags except for the first 3
$tags = \craft\elements\Tag::find()
    ->offset(3)
    ->all();

:::

`orderBy`

Determines the order that the tags should be returned in. (If empty, defaults to title ASC.)

::: code

{# Fetch all tags in order of date created #}
{% set tags = craft.tags()
    .orderBy('dateCreated asc')
    .all() %}

// Fetch all tags in order of date created
$tags = \craft\elements\Tag::find()
    ->orderBy('dateCreated asc')
    ->all();

:::

`preferSites`

If unique is set, this determines which site should be selected when querying multi-site elements.

For example, if element “Foo” exists in Site A and Site B, and element “Bar” exists in Site B and Site C, and this is set to ['c', 'b', 'a'], then Foo will be returned for Site C, and Bar will be returned for Site B.

If this isn’t set, then preference goes to the current site.

::: code

{# Fetch unique tags from Site A, or Site B if they don’t exist in Site A #}
{% set tags = craft.tags()
    .site('*')
    .unique()
    .preferSites(['a', 'b'])
    .all() %}

// Fetch unique tags from Site A, or Site B if they don’t exist in Site A
$tags = \craft\elements\Tag::find()
    ->site('*')
    ->unique()
    ->preferSites(['a', 'b'])
    ->all();

:::

`relatedTo`

Narrows the query results to only tags that are related to certain other elements.

See Relations for a full explanation of how to work with this parameter.

::: code

{# Fetch all tags that are related to myCategory #}
{% set tags = craft.tags()
    .relatedTo(myCategory)
    .all() %}

// Fetch all tags that are related to $myCategory
$tags = \craft\elements\Tag::find()
    ->relatedTo($myCategory)
    ->all();

:::

`search`

Narrows the query results to only tags that match a search query.

See Searching for a full explanation of how to work with this parameter.

::: code

{# Get the search query from the 'q' query string param #}
{% set searchQuery = craft.app.request.getQueryParam('q') %}

{# Fetch all tags that match the search query #}
{% set tags = craft.tags()
    .search(searchQuery)
    .all() %}

// Get the search query from the 'q' query string param
$searchQuery = \Craft::$app->request->getQueryParam('q');

// Fetch all tags that match the search query
$tags = \craft\elements\Tag::find()
    ->search($searchQuery)
    ->all();

:::

`site`

Determines which site(s) the tags should be queried in.

The current site will be used by default.

Possible values include:

Value	Fetches tags…
`'foo'`	from the site with a handle of `foo`.
`['foo', 'bar']`	from a site with a handle of `foo` or `bar`.
`['not', 'foo', 'bar']`	not in a site with a handle of `foo` or `bar`.
a craft\models\Site object	from the site represented by the object.
`'*'`	from any site.

::: tip If multiple sites are specified, elements that belong to multiple sites will be returned multiple times. If you only want unique elements to be returned, use unique in conjunction with this. :::

::: code

{# Fetch tags from the Foo site #}
{% set tags = craft.tags()
    .site('foo')
    .all() %}

// Fetch tags from the Foo site
$tags = \craft\elements\Tag::find()
    ->site('foo')
    ->all();

:::

`siteId`

Determines which site(s) the tags should be queried in, per the site’s ID.

The current site will be used by default.

::: code

{# Fetch tags from the site with an ID of 1 #}
{% set tags = craft.tags()
    .siteId(1)
    .all() %}

// Fetch tags from the site with an ID of 1
$tags = \craft\elements\Tag::find()
    ->siteId(1)
    ->all();

:::

`title`

Narrows the query results based on the tags’ titles.

Possible values include:

Value	Fetches tags…
`'Foo'`	with a title of `Foo`.
`'Foo*'`	with a title that begins with `Foo`.
`'*Foo'`	with a title that ends with `Foo`.
`'Foo'`	with a title that contains `Foo`.
`'not Foo'`	with a title that doesn’t contain `Foo`.
`['Foo', 'Bar']`	with a title that contains `Foo` or `Bar`.
`['not', 'Foo', 'Bar']`	with a title that doesn’t contain `Foo` or `Bar`.

::: code

{# Fetch tags with a title that contains "Foo" #}
{% set tags = craft.tags()
    .title('*Foo*')
    .all() %}

// Fetch tags with a title that contains "Foo"
$tags = \craft\elements\Tag::find()
    ->title('*Foo*')
    ->all();

:::

`trashed`

Narrows the query results to only tags that have been soft-deleted.

::: code

{# Fetch trashed tags #}
{% set tags = craft.tags()
    .trashed()
    .all() %}

// Fetch trashed tags
$tags = \craft\elements\Tag::find()
    ->trashed()
    ->all();

:::

`uid`

Narrows the query results based on the tags’ UIDs.

::: code

{# Fetch the tag by its UID #}
{% set tag = craft.tags()
    .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    .one() %}

// Fetch the tag by its UID
$tag = \craft\elements\Tag::find()
    ->uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    ->one();

:::

`unique`

Determines whether only elements with unique IDs should be returned by the query.

This should be used when querying elements from multiple sites at the same time, if “duplicate” results is not desired.

::: code

{# Fetch unique tags across all sites #}
{% set tags = craft.tags()
    .site('*')
    .unique()
    .all() %}

// Fetch unique tags across all sites
$tags = \craft\elements\Tag::find()
    ->site('*')
    ->unique()
    ->all();

:::

`uri`

Narrows the query results based on the tags’ URIs.

Possible values include:

Value	Fetches tags…
`'foo'`	with a URI of `foo`.
`'foo*'`	with a URI that begins with `foo`.
`'*foo'`	with a URI that ends with `foo`.
`'foo'`	with a URI that contains `foo`.
`'not foo'`	with a URI that doesn’t contain `foo`.
`['foo', 'bar']`	with a URI that contains `foo` or `bar`.
`['not', 'foo', 'bar']`	with a URI that doesn’t contain `foo` or `bar`.

::: code

{# Get the requested URI #}
{% set requestedUri = craft.app.request.getPathInfo() %}

{# Fetch the tag with that URI #}
{% set tag = craft.tags()
    .uri(requestedUri|literal)
    .one() %}

// Get the requested URI
$requestedUri = \Craft::$app->request->getPathInfo();

// Fetch the tag with that URI
$tag = \craft\elements\Tag::find()
    ->uri(\craft\helpers\Db::escapeParam($requestedUri))
    ->one();

:::

`with`

Causes the query to return matching tags eager-loaded with related elements.

See Eager-Loading Elements for a full explanation of how to work with this parameter.

::: code

{# Fetch tags eager-loaded with the "Related" field’s relations #}
{% set tags = craft.tags()
    .with(['related'])
    .all() %}

// Fetch tags eager-loaded with the "Related" field’s relations
$tags = \craft\elements\Tag::find()
    ->with(['related'])
    ->all();

:::

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tag-queries.md

tag-queries.md

Tag Queries

Example

Parameters

`anyStatus`

`asArray`

`clearCachedResult`

`dateCreated`

`dateUpdated`

`fixedOrder`

`group`

`groupId`

`id`

`ignorePlaceholders`

`inReverse`

`limit`

`offset`

`orderBy`

`preferSites`

`relatedTo`

`search`

`site`

`siteId`

`title`

`trashed`

`uid`

`unique`

`uri`

`with`

Files

tag-queries.md

Latest commit

History

tag-queries.md

File metadata and controls

Tag Queries

Example

Parameters

anyStatus

asArray

clearCachedResult

dateCreated

dateUpdated

fixedOrder

group

groupId

id

ignorePlaceholders

inReverse

limit

offset

orderBy

preferSites

relatedTo

search

site

siteId

title

trashed

uid

unique

uri

with

`anyStatus`

`asArray`

`clearCachedResult`

`dateCreated`

`dateUpdated`

`fixedOrder`

`group`

`groupId`

`id`

`ignorePlaceholders`

`inReverse`

`limit`

`offset`

`orderBy`

`preferSites`

`relatedTo`

`search`

`site`

`siteId`

`title`

`trashed`

`uid`

`unique`

`uri`

`with`