Tag Queries

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

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

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:

  1. Create a tag query with craft.tags().
  2. Set the group parameter on it.
  3. Fetch the tags with .all().
  4. 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:

anyStatus

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

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

asArray

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

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

dateCreated

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

Possible values include:

ValueFetches 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.
{# 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() %}

dateUpdated

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

Possible values include:

ValueFetches 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.
{# Fetch tags updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}

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

fixedOrder

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

{# Fetch tags in a specific order #}
{% set tags = craft.tags()
    .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:

ValueFetches 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 objectin a group represented by the object.
{# Fetch tags in the Foo group #}
{% set tags = craft.tags()
    .group('foo')
    .all() %}

groupId

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

Possible values include:

ValueFetches tags…
1in 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.
{# Fetch tags in the group with an ID of 1 #}
{% set tags = craft.tags()
    .groupId(1)
    .all() %}

id

Narrows the query results based on the tags’ IDs.

Possible values include:

ValueFetches tags…
1with 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.
{# Fetch the tag by its ID #}
{% set tag = craft.tags()
    .id(1)
    .one() %}

TIP

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

inReverse

Causes the query results to be returned in reverse order.

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

limit

Determines the number of tags that should be returned.

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

offset

Determines how many tags should be skipped in the results.

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

orderBy

Determines the order that the tags should be returned in.

{# Fetch all tags in order of date created #}
{% set tags = craft.tags()
    .orderBy('elements.dateCreated asc')
    .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.

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

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.

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

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

site

Determines which site the tags should be queried in.

The current site will be used by default.

Possible values include:

ValueFetches tags…
'foo'from the site with a handle of foo.
a \craft\elements\db\Site objectfrom the site represented by the object.
{# Fetch tags from the Foo site #}
{% set tags = craft.tags()
    .site('foo')
    .all() %}

siteId

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

The current site will be used by default.

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

title

Narrows the query results based on the tags’ titles.

Possible values include:

ValueFetches 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.
{# Fetch tags with a title that contains "Foo" #}
{% set tags = craft.tags()
    .title('*Foo*')
    .all() %}

uid

Narrows the query results based on the tags’ UIDs.

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

uri

Narrows the query results based on the tags’ URIs.

Possible values include:

ValueFetches 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.
{# Get the requested URI #}
{% set requestedUri = craft.app.request.getPathInfo() %}

{# Fetch the tag with that URI #}
{% set tag = craft.tags()
    .uri(requestedUri|literal)
    .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.

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