You can fetch categories in your templates or PHP code using category queries.
::: code
{# Create a new category query #}
{% set myCategoryQuery = craft.categories() %}// Create a new category query
$myCategoryQuery = \craft\elements\Category::find();:::
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. :::
We can display a navigation for all the categories in a category group called “Topics” by doing the following:
- Create a category query with
craft.categories(). - Set the group parameter on it.
- Fetch the categories with
.all(). - 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>Category queries support the following parameters:
Narrows the query results to only categories that are up to a certain distance away from the category specified by ancestorOf.
::: code
{# Fetch categories above this one #}
{% set categories = craft.categories()
.ancestorOf(myCategory)
.ancestorDist(3)
.all() %}// Fetch categories above this one
$categories = \craft\elements\Category::find()
->ancestorOf($myCategory)
->ancestorDist(3)
->all();:::
Narrows the query results to only categories that are ancestors of another category.
Possible values include:
| Value | Fetches categories… |
|---|---|
1 |
above the category with an ID of 1. |
| a Category object | above the category represented by the object. |
::: code
{# Fetch categories above this one #}
{% set categories = craft.categories()
.ancestorOf(myCategory)
.all() %}// Fetch categories above this one
$categories = \craft\elements\Category::find()
->ancestorOf($myCategory)
->all();:::
::: tip This can be combined with ancestorDist if you want to limit how far away the ancestor categories can be. :::
Clears out the status and enabledForSite parameters.
::: code
{# Fetch all categories, regardless of status #}
{% set categories = craft.categories()
.anyStatus()
.all() %}// Fetch all categories, regardless of status
$categories = \craft\elements\Category::find()
->anyStatus()
->all();:::
Causes the query to return matching categories as arrays of data, rather than Category objects.
::: code
{# Fetch categories as arrays #}
{% set categories = craft.categories()
.asArray()
.all() %}// Fetch categories as arrays
$categories = \craft\elements\Category::find()
->asArray()
->all();:::
Narrows the query results based on the categories’ creation dates.
Possible values include:
| Value | Fetches 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. |
::: code
{# 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() %}// Fetch categories 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);
$categories = \craft\elements\Category::find()
->dateCreated(['and', ">= {$start}", "< {$end}"])
->all();:::
Narrows the query results based on the categories’ last-updated dates.
Possible values include:
| Value | Fetches 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. |
::: code
{# Fetch categories updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}
{% set categories = craft.categories()
.dateUpdated(">= #{lastWeek}")
.all() %}// Fetch categories updated in the last week
$lastWeek = (new \DateTime('1 week ago'))->format(\DateTime::ATOM);
$categories = \craft\elements\Category::find()
->dateUpdated(">= {$lastWeek}")
->all();:::
Narrows the query results to only categories that are up to a certain distance away from the category specified by descendantOf.
::: code
{# Fetch categories below this one #}
{% set categories = craft.categories()
.descendantOf(myCategory)
.descendantDist(3)
.all() %}// Fetch categories below this one
$categories = \craft\elements\Category::find()
->descendantOf($myCategory)
->descendantDist(3)
->all();:::
Narrows the query results to only categories that are descendants of another category.
Possible values include:
| Value | Fetches categories… |
|---|---|
1 |
below the category with an ID of 1. |
| a Category object | below the category represented by the object. |
::: code
{# Fetch categories below this one #}
{% set categories = craft.categories()
.descendantOf(myCategory)
.all() %}// Fetch categories below this one
$categories = \craft\elements\Category::find()
->descendantOf($myCategory)
->all();:::
::: tip This can be combined with descendantDist if you want to limit how far away the descendant categories can be. :::
Narrows the query results to only drafts created by a given user.
Possible values include:
| Value | Fetches drafts… |
|---|---|
1 |
created by the user with an ID of 1. |
a \craft\elements\db\User object |
by the user represented by the object. |
::: code
{# Fetch drafts by the current user #}
{% set categories = craft.categories()
.draftCreator(currentUser)
.all() %}// Fetch drafts by the current user
$categories = \craft\elements\Category::find()
->draftCreator(Craft::$app->user->identity)
->all();:::
Narrows the query results based on the categories’ draft’s ID (from the drafts table).
Possible values include:
| Value | Fetches drafts… |
|---|---|
1 |
for the draft with an ID of 1. |
::: code
{# Fetch a draft #}
{% set categories = craft.categories()
.draftId(10)
.all() %}// Fetch a draft
$categories = \craft\elements\Category::find()
->draftIf(10)
->all();:::
Narrows the query results to only drafts of a given category.
Possible values include:
| Value | Fetches drafts… |
|---|---|
1 |
for the category with an ID of 1. |
| a Category object | for the category represented by the object. |
::: code
{# Fetch drafts of the category #}
{% set categories = craft.categories()
.draftOf(myCategory)
.all() %}// Fetch drafts of the category
$categories = \craft\elements\Category::find()
->draftOf($myCategory)
->all();:::
Narrows the query results to only drafts categories.
::: code
{# Fetch a draft category #}
{% set categories = {twig-function}
.drafts()
.id(123)
.one() %}// Fetch a draft category
$categories = \craft\elements\Category::find()
->drafts()
->id(123)
->one();:::
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:
| Value | Fetches categories… |
|---|---|
true (default) |
that are enabled in the site. |
false |
whether they are enabled or not in the site. |
::: code
{# Fetch all categories, including ones disabled for this site #}
{% set categories = craft.categories()
.enabledForSite(false)
.all() %}// Fetch all categories, including ones disabled for this site
$categories = \craft\elements\Category::find()
->enabledForSite(false)
->all();:::
Causes the query results to be returned in the order specified by id.
::: code
{# Fetch categories in a specific order #}
{% set categories = craft.categories()
.id([1, 2, 3, 4, 5])
.fixedOrder()
.all() %}// Fetch categories in a specific order
$categories = \craft\elements\Category::find()
->id([1, 2, 3, 4, 5])
->fixedOrder()
->all();:::
Narrows the query results based on the category groups the categories belong to.
Possible values include:
| Value | Fetches 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 object | in a group represented by the object. |
::: code
{# Fetch categories in the Foo group #}
{% set categories = craft.categories()
.group('foo')
.all() %}// Fetch categories in the Foo group
$categories = \craft\elements\Category::find()
->group('foo')
->all();:::
Narrows the query results based on the category groups the categories belong to, per the groups’ IDs.
Possible values include:
| Value | Fetches categories… |
|---|---|
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 categories in the group with an ID of 1 #}
{% set categories = craft.categories()
.groupId(1)
.all() %}// Fetch categories in the group with an ID of 1
$categories = \craft\elements\Category::find()
->groupId(1)
->all();:::
Narrows the query results based on whether the categories have any descendants.
(This has the opposite effect of calling leaves.)
::: code
{# Fetch categories that have descendants #}
{% set categories = craft.categories()
.hasDescendants()
.all() %}// Fetch categories that have descendants
$categories = \craft\elements\Category::find()
->hasDescendants()
->all();:::
Narrows the query results based on the categories’ IDs.
Possible values include:
| Value | Fetches categories… |
|---|---|
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 category by its ID #}
{% set category = craft.categories()
.id(1)
.one() %}// Fetch the category by its ID
$category = \craft\elements\Category::find()
->id(1)
->one();:::
::: tip This can be combined with fixedOrder if you want the results to be returned in a specific order. :::
Causes the query to return matching categories as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement().
Causes the query results to be returned in reverse order.
::: code
{# Fetch categories in reverse #}
{% set categories = craft.categories()
.inReverse()
.all() %}// Fetch categories in reverse
$categories = \craft\elements\Category::find()
->inReverse()
->all();:::
Narrows the query results based on whether the categories are “leaves” (categories with no descendants).
(This has the opposite effect of calling hasDescendants.)
::: code
{# Fetch categories that have no descendants #}
{% set categories = craft.categories()
.leaves()
.all() %}// Fetch categories that have no descendants
$categories = \craft\elements\Category::find()
->leaves()
->all();:::
Narrows the query results based on the categories’ level within the structure.
Possible values include:
| Value | Fetches categories… |
|---|---|
1 |
with 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. |
::: code
{# Fetch categories positioned at level 3 or above #}
{% set categories = craft.categories()
.level('>= 3')
.all() %}// Fetch categories positioned at level 3 or above
$categories = \craft\elements\Category::find()
->level('>= 3')
->all();:::
Determines the number of categories that should be returned.
::: code
{# Fetch up to 10 categories #}
{% set categories = craft.categories()
.limit(10)
.all() %}// Fetch up to 10 categories
$categories = \craft\elements\Category::find()
->limit(10)
->all();:::
Narrows the query results to only the category that comes immediately after another category.
Possible values include:
| Value | Fetches the category… |
|---|---|
1 |
after the category with an ID of 1. |
| a Category object | after the category represented by the object. |
::: code
{# Fetch the next category #}
{% set category = craft.categories()
.nextSiblingOf(myCategory)
.one() %}// Fetch the next category
$category = \craft\elements\Category::find()
->nextSiblingOf($myCategory)
->one();:::
Determines how many categories should be skipped in the results.
::: code
{# Fetch all categories except for the first 3 #}
{% set categories = craft.categories()
.offset(3)
.all() %}// Fetch all categories except for the first 3
$categories = \craft\elements\Category::find()
->offset(3)
->all();:::
Determines the order that the categories should be returned in.
::: code
{# Fetch all categories in order of date created #}
{% set categories = craft.categories()
.orderBy('dateCreated asc')
.all() %}// Fetch all categories in order of date created
$categories = \craft\elements\Category::find()
->orderBy('dateCreated asc')
->all();:::
Narrows the query results to only categories that are positioned after another category.
Possible values include:
| Value | Fetches categories… |
|---|---|
1 |
after the category with an ID of 1. |
| a Category object | after the category represented by the object. |
::: code
{# Fetch categories after this one #}
{% set categories = craft.categories()
.positionedAfter(myCategory)
.all() %}// Fetch categories after this one
$categories = \craft\elements\Category::find()
->positionedAfter($myCategory)
->all();:::
Narrows the query results to only categories that are positioned before another category.
Possible values include:
| Value | Fetches categories… |
|---|---|
1 |
before the category with an ID of 1. |
| a Category object | before the category represented by the object. |
::: code
{# Fetch categories before this one #}
{% set categories = craft.categories()
.positionedBefore(myCategory)
.all() %}// Fetch categories before this one
$categories = \craft\elements\Category::find()
->positionedBefore($myCategory)
->all();:::
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 categories from Site A, or Site B if they don’t exist in Site A #}
{% set categories = craft.categories()
.site('*')
.unique()
.preferSites(['a', 'b'])
.all() %}// Fetch unique categories from Site A, or Site B if they don’t exist in Site A
$categories = \craft\elements\Category::find()
->site('*')
->unique()
->preferSites(['a', 'b'])
->all();:::
Narrows the query results to only the category that comes immediately before another category.
Possible values include:
| Value | Fetches the category… |
|---|---|
1 |
before the category with an ID of 1. |
| a Category object | before the category represented by the object. |
::: code
{# Fetch the previous category #}
{% set category = craft.categories()
.prevSiblingOf(myCategory)
.one() %}// Fetch the previous category
$category = \craft\elements\Category::find()
->prevSiblingOf($myCategory)
->one();:::
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.
::: code
{# Fetch all categories that are related to myCategory #}
{% set categories = craft.categories()
.relatedTo(myCategory)
.all() %}// Fetch all categories that are related to $myCategory
$categories = \craft\elements\Category::find()
->relatedTo($myCategory)
->all();:::
Narrows the query results to only revisions created by a given user.
Possible values include:
| Value | Fetches revisions… |
|---|---|
1 |
created by the user with an ID of 1. |
a \craft\elements\db\User object |
by the user represented by the object. |
::: code
{# Fetch revisions by the current user #}
{% set categories = craft.categories()
.revisionCreator(currentUser)
.all() %}// Fetch revisions by the current user
$categories = \craft\elements\Category::find()
->revisionCreator(Craft::$app->user->identity)
->all();:::
Narrows the query results based on the categories’ revision’s ID (from the revisions table).
Possible values include:
| Value | Fetches revisions… |
|---|---|
1 |
for the revision with an ID of 1. |
::: code
{# Fetch a revision #}
{% set categories = craft.categories()
.revisionId(10)
.all() %}// Fetch a revision
$categories = \craft\elements\Category::find()
->revisionIf(10)
->all();:::
Narrows the query results to only revisions of a given category.
Possible values include:
| Value | Fetches revisions… |
|---|---|
1 |
for the category with an ID of 1. |
| a Category object | for the category represented by the object. |
::: code
{# Fetch revisions of the category #}
{% set categories = craft.categories()
.revisionOf(myCategory)
.all() %}// Fetch revisions of the category
$categories = \craft\elements\Category::find()
->revisionOf($myCategory)
->all();:::
Narrows the query results to only revision categories.
::: code
{# Fetch a revision category #}
{% set categories = {twig-function}
.revisions()
.id(123)
.one() %}// Fetch a revision category
$categories = \craft\elements\Category::find()
->revisions()
->id(123)
->one();:::
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.
::: code
{# Get the search query from the 'q' query string param #}
{% set searchQuery = craft.app.request.getQueryParam('q') %}
{# Fetch all categories that match the search query #}
{% set categories = craft.categories()
.search(searchQuery)
.all() %}// Get the search query from the 'q' query string param
$searchQuery = \Craft::$app->request->getQueryParam('q');
// Fetch all categories that match the search query
$categories = \craft\elements\Category::find()
->search($searchQuery)
->all();:::
Narrows the query results to only categories that are siblings of another category.
Possible values include:
| Value | Fetches categories… |
|---|---|
1 |
beside the category with an ID of 1. |
| a Category object | beside the category represented by the object. |
::: code
{# Fetch categories beside this one #}
{% set categories = craft.categories()
.siblingOf(myCategory)
.all() %}// Fetch categories beside this one
$categories = \craft\elements\Category::find()
->siblingOf($myCategory)
->all();:::
Determines which site(s) the categories should be queried in.
The current site will be used by default.
Possible values include:
| Value | Fetches categories… |
|---|---|
'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\elements\db\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 categories from the Foo site #}
{% set categories = craft.categories()
.site('foo')
.all() %}// Fetch categories from the Foo site
$categories = \craft\elements\Category::find()
->site('foo')
->all();:::
Determines which site(s) the categories should be queried in, per the site’s ID.
The current site will be used by default.
::: code
{# Fetch categories from the site with an ID of 1 #}
{% set categories = craft.categories()
.siteId(1)
.all() %}// Fetch categories from the site with an ID of 1
$categories = \craft\elements\Category::find()
->siteId(1)
->all();:::
Narrows the query results based on the categories’ slugs.
Possible values include:
| Value | Fetches 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. |
::: code
{# 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() %}// Get the requested category slug from the URL
$requestedSlug = \Craft::$app->request->getSegment(3);
// Fetch the category with that slug
$category = \craft\elements\Category::find()
->slug(\craft\helpers\Db::escapeParam($requestedSlug))
->one();:::
Narrows the query results based on the categories’ statuses.
Possible values include:
| Value | Fetches categories… |
|---|---|
'enabled' (default) |
that are enabled. |
'disabled' |
that are disabled. |
::: code
{# Fetch disabled categories #}
{% set categories = craft.categories()
.status('disabled')
.all() %}// Fetch disabled categories
$categories = \craft\elements\Category::find()
->status('disabled')
->all();:::
Narrows the query results based on the categories’ titles.
Possible values include:
| Value | Fetches 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. |
::: code
{# Fetch categories with a title that contains "Foo" #}
{% set categories = craft.categories()
.title('*Foo*')
.all() %}// Fetch categories with a title that contains "Foo"
$categories = \craft\elements\Category::find()
->title('*Foo*')
->all();:::
Narrows the query results to only categories that have been soft-deleted.
::: code
{# Fetch trashed categories #}
{% set categories = craft.categories()
.trashed()
.all() %}// Fetch trashed categories
$categories = \craft\elements\Category::find()
->trashed()
->all();:::
Narrows the query results based on the categories’ UIDs.
::: code
{# Fetch the category by its UID #}
{% set category = craft.categories()
.uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
.one() %}// Fetch the category by its UID
$category = \craft\elements\Category::find()
->uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
->one();:::
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 categories across all sites #}
{% set categories = craft.categories()
.site('*')
.unique()
.all() %}// Fetch unique categories across all sites
$categories = \craft\elements\Category::find()
->site('*')
->unique()
->all();:::
Narrows the query results based on the categories’ URIs.
Possible values include:
| Value | Fetches 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. |
::: code
{# Get the requested URI #}
{% set requestedUri = craft.app.request.getPathInfo() %}
{# Fetch the category with that URI #}
{% set category = craft.categories()
.uri(requestedUri|literal)
.one() %}// Get the requested URI
$requestedUri = \Craft::$app->request->getPathInfo();
// Fetch the category with that URI
$category = \craft\elements\Category::find()
->uri(\craft\helpers\Db::escapeParam($requestedUri))
->one();:::
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.
::: code
{# Fetch categories eager-loaded with the "Related" field’s relations #}
{% set categories = craft.categories()
.with(['related'])
.all() %}// Fetch categories eager-loaded with the "Related" field’s relations
$categories = \craft\elements\Category::find()
->with(['related'])
->all();:::