Category Queries

You can fetch categories in your templates or PHP code using category queries.

{# Create a new category query #}
{% set myCategoryQuery = craft.categories() %}

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

TIP

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

Example

We can display a navigation for all the categories in a category group called “Topics” by doing the following:

  1. Create a category query with craft.categories().
  2. Set the group parameter on it.
  3. Fetch the categories with .all().
  4. Loop through the categories using a nav tag to create the navigation HTML.
{# Create a category query with the 'group' parameter #}
{% set myCategoryQuery = craft.categories()
    .group('topics') %}

{# Fetch the categories #}
{% set categories = myCategoryQuery.all() %}

{# Display the navigation #}
<ul>
    {% nav category in categories %}
        <li>
            <a href="{{ category.url }}">{{ category.title }}</a>
            {% ifchildren %}
                <ul>
                    {% children %}
                </ul>
            {% endifchildren %}
        </li>
    {% endnav %}
</ul>

Parameters

Category queries support the following parameters:

ancestorDist

Narrows the query results to only categories that are up to a certain distance away from the category specified by ancestorOf.

{# Fetch categories above this one #}
{% set categories = craft.categories()
    .ancestorOf(myCategory)
    .ancestorDist(3)
    .all() %}

ancestorOf

Narrows the query results to only categories that are ancestors of another category.

Possible values include:

ValueFetches categories…
1above the category with an ID of 1.
a Category objectabove the category represented by the object.
{# Fetch categories above this one #}
{% set categories = craft.categories()
    .ancestorOf(myCategory)
    .all() %}

TIP

This can be combined with ancestorDist if you want to limit how far away the ancestor categories can be.

anyStatus

Clears out the status and enabledForSite parameters.

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

asArray

Causes the query to return matching categories as arrays of data, rather than Category objects.

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

dateCreated

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

Possible values include:

ValueFetches categories…
'>= 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 categories created last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

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

dateUpdated

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

Possible values include:

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

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

descendantDist

Narrows the query results to only categories that are up to a certain distance away from the category specified by descendantOf.

{# Fetch categories below this one #}
{% set categories = craft.categories()
    .descendantOf(myCategory)
    .descendantDist(3)
    .all() %}

descendantOf

Narrows the query results to only categories that are descendants of another category.

Possible values include:

ValueFetches categories…
1below the category with an ID of 1.
a Category objectbelow the category represented by the object.
{# Fetch categories below this one #}
{% set categories = craft.categories()
    .descendantOf(myCategory)
    .all() %}

TIP

This can be combined with descendantDist if you want to limit how far away the descendant categories can be.

enabledForSite

Narrows the query results based on whether the categories are enabled in the site they’re being queried in, per the site parameter.

Possible values include:

ValueFetches categories…
true(default)that are enabled in the site.
falsewhether they are enabled or not in the site.
{# Fetch all categories, including ones disabled for this site #}
{% set categories = craft.categories()
    .enabledForSite(false)
    .all() %}

fixedOrder

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

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

group

Narrows the query results based on the category groups the categories belong to.

Possible values include:

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

groupId

Narrows the query results based on the category groups the categories belong to, per the groups’ IDs.

Possible values include:

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

hasDescendants

Narrows the query results based on whether the categories have any descendants.

(This has the opposite effect of calling leaves.)

{# Fetch categories that have descendants #}
{% set categories = craft.categories()
    .hasDescendants()
    .all() %}

id

Narrows the query results based on the categories’ IDs.

Possible values include:

ValueFetches categories…
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 category by its ID #}
{% set category = craft.categories()
    .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 categories in reverse #}
{% set categories = craft.categories()
    .inReverse()
    .all() %}

leaves

Narrows the query results based on whether the categories are “leaves” (categories with no descendants).

(This has the opposite effect of calling hasDescendants.)

{# Fetch categories that have no descendants #}
{% set categories = craft.categories()
    .leaves()
    .all() %}

level

Narrows the query results based on the categories’ level within the structure.

Possible values include:

ValueFetches categories…
1with a level of 1.
'not 1'not with a level of 1.
'>= 3'with a level greater than or equal to 3.
[1, 2]with a level of 1 or 2
['not', 1, 2]not with level of 1 or 2.
{# Fetch categories positioned at level 3 or above #}
{% set categories = craft.categories()
    .level('>= 3')
    .all() %}

limit

Determines the number of categories that should be returned.

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

nextSiblingOf

Narrows the query results to only the category that comes immediately after another category.

Possible values include:

ValueFetches the category…
1after the category with an ID of 1.
a Category objectafter the category represented by the object.
{# Fetch the next category #}
{% set category = craft.categories()
    .nextSiblingOf(myCategory)
    .one() %}

offset

Determines how many categories should be skipped in the results.

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

orderBy

Determines the order that the categories should be returned in.

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

positionedAfter

Narrows the query results to only categories that are positioned after another category.

Possible values include:

ValueFetches categories…
1after the category with an ID of 1.
a Category objectafter the category represented by the object.
{# Fetch categories after this one #}
{% set categories = craft.categories()
    .positionedAfter(myCategory)
    .all() %}

positionedBefore

Narrows the query results to only categories that are positioned before another category.

Possible values include:

ValueFetches categories…
1before the category with an ID of 1.
a Category objectbefore the category represented by the object.
{# Fetch categories before this one #}
{% set categories = craft.categories()
    .positionedBefore(myCategory)
    .all() %}

prevSiblingOf

Narrows the query results to only the category that comes immediately before another category.

Possible values include:

ValueFetches the category…
1before the category with an ID of 1.
a Category objectbefore the category represented by the object.
{# Fetch the previous category #}
{% set category = craft.categories()
    .prevSiblingOf(myCategory)
    .one() %}

relatedTo

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

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

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

Narrows the query results to only categories 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 categories that match the search query #}
{% set categories = craft.categories()
    .search(searchQuery)
    .all() %}

siblingOf

Narrows the query results to only categories that are siblings of another category.

Possible values include:

ValueFetches categories…
1beside the category with an ID of 1.
a Category objectbeside the category represented by the object.
{# Fetch categories beside this one #}
{% set categories = craft.categories()
    .siblingOf(myCategory)
    .all() %}

site

Determines which site the categories should be queried in.

The current site will be used by default.

Possible values include:

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

siteId

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

The current site will be used by default.

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

slug

Narrows the query results based on the categories’ slugs.

Possible values include:

ValueFetches categories…
'foo'with a slug of foo.
'foo*'with a slug that begins with foo.
'*foo'with a slug that ends with foo.
'*foo*'with a slug that contains foo.
'not *foo*'with a slug that doesn’t contain foo.
['*foo*', '*bar*'with a slug that contains foo or bar.
['not', '*foo*', '*bar*']with a slug that doesn’t contain foo or bar.
{# Get the requested category slug from the URL #}
{% set requestedSlug = craft.app.request.getSegment(3) %}

{# Fetch the category with that slug #}
{% set category = craft.categories()
    .slug(requestedSlug|literal)
    .one() %}

status

Narrows the query results based on the categories’ statuses.

Possible values include:

ValueFetches categories…
'enabled'(default)that are enabled.
'disabled'that are disabled.
{# Fetch disabled categories #}
{% set categories = craft.categories()
    .status('disabled')
    .all() %}

title

Narrows the query results based on the categories’ titles.

Possible values include:

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

uid

Narrows the query results based on the categories’ UIDs.

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

uri

Narrows the query results based on the categories’ URIs.

Possible values include:

ValueFetches categories…
'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 category with that URI #}
{% set category = craft.categories()
    .uri(requestedUri|literal)
    .one() %}

with

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

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

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