We're off to DotAll 2022 in Brooklyn NY (plus a little extra sightseeing time). Our support will be limited.

Comment Queries#

You can fetch comments in your templates or PHP code using comment queries.

{# Create a new comment query #}
{% set myQuery = craft.comments.fetch() %}

// Create a new comment query
$myQuery = \verbb\comments\elements\Comment::find();

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

See Introduction to Element Queries (opens new window) in the Craft docs to learn about how element queries work.

Example#

We can display comments for a given user by doing the following:

Create a comment query with craft.comments.fetch().
Set the userId, limit and status parameters on it.
Fetch all comments with .all() and output.
Loop through the comments using a for (opens new window) tag to output the contents.

{# Create a comments query with the 'userId', 'limit', and 'status' parameters #}
{% set commentsQuery = craft.comments.fetch()
    .userId(currentUser.id)
    .limit(10)
    .status('pending') %}

{# Fetch the Comments #}
{% set comments = commentsQuery.all() %}

{# Display their contents #}
{% for comment in comments %}
    <p>{{ comment.comment }}</p>
{% endfor %}

Parameters#

Comment queries support the following parameters:

`after`#

Narrows the query results to only comments that were posted on or after a certain date.

Possible values include:

Value	Fetches comments…
`'2018-04-01'`	that were posted after 2018-04-01.
a DateTime (opens new window) object	that were posted after the date represented by the object.

{# Fetch comments posted this month #}
{% set firstDayOfMonth = date('first day of this month') %}

{% set comments = craft.comments.fetch()
    .after(firstDayOfMonth)
    .all() %}

// Fetch comments posted this month
$firstDayOfMonth = new \DateTime('first day of this month');

$comments = \verbb\comments\elements\Comment::find()
    ->after($firstDayOfMonth)
    ->all();

`ancestorDist`#

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

{# Fetch comments above this one #}
{% set comments = craft.comments.fetch()
    .ancestorOf(comment)
    .ancestorDist(3)
    .all() %}

// Fetch comments above this one
$comments = \verbb\comments\elements\Comment::find()
    ->ancestorOf($comment)
    ->ancestorDist(3)
    ->all();

`ancestorOf`#

Narrows the query results to only comments that are ancestors of another comment.

Possible values include:

Value	Fetches comments…
`1`	above the comment with an ID of 1.
a Comment object	above the comment represented by the object.

{# Fetch comments above this one #}
{% set comments = craft.comments.fetch()
    .ancestorOf(comment)
    .all() %}

// Fetch comments above this one
$comments = \verbb\comments\elements\Comment::find()
    ->ancestorOf($comment)
    ->all();

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

`anyStatus`#

Clears out the status() (opens new window) and enabledForSite() (opens new window) parameters.

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

// Fetch all comments, regardless of status
$comments = \verbb\comments\elements\Comment::find()
    ->anyStatus()
    ->all();

`asArray`#

Causes the query to return matching comments as arrays of data, rather than Comment objects.

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

// Fetch comments as arrays
$comments = \verbb\comments\elements\Comment::find()
    ->asArray()
    ->all();

`before`#

Narrows the query results to only comments that were posted before a certain date.

Possible values include:

Value	Fetches comments…
`'2018-04-01'`	that were posted before 2018-04-01.
a DateTime (opens new window) object	that were posted before the date represented by the object.

{# Fetch comments posted before this month #}
{% set firstDayOfMonth = date('first day of this month') %}

{% set comments = craft.comments.fetch()
    .before(firstDayOfMonth)
    .all() %}

// Fetch comments posted before this month
$firstDayOfMonth = new \DateTime('first day of this month');

$comments = \verbb\comments\elements\Comment::find()
    ->before($firstDayOfMonth)
    ->all();

`commentDate`#

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

Possible values include:

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

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

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

$comments = \verbb\comments\elements\Comment::find()
    ->commentDate(['and', ">= {$start}", "< {$end}"])
    ->all();

`dateCreated`#

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

Possible values include:

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

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

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

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

`dateUpdated`#

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

Possible values include:

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

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

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

$comments = \verbb\comments\elements\Comment::find()
    ->dateUpdated(">= {$lastWeek}")
    ->all();

`descendantDist`#

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

{# Fetch comments below this one #}
{% set comments = craft.comments.fetch()
    .descendantOf(comment)
    .descendantDist(3)
    .all() %}

// Fetch comments below this one
$comments = \verbb\comments\elements\Comment::find()
    ->descendantOf($comment)
    ->descendantDist(3)
    ->all();

`descendantOf`#

Narrows the query results to only comments that are descendants of another comment.

Possible values include:

Value	Fetches comments…
`1`	below the comment with an ID of 1.
a Comment object	below the comment represented by the object.

{# Fetch comments below this one #}
{% set comments = craft.comments.fetch()
    .descendantOf(comment)
    .all() %}

// Fetch comments below this one
$comments = \verbb\comments\elements\Comment::find()
    ->descendantOf($comment)
    ->all();

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

`email`#

Narrows the query results based on the comments’ email addresses.

Possible values include:

Value	Fetches comments with users…
`'foo@bar.baz'`	with an email of `foo@bar.baz`.
`'not foo@bar.baz'`	not with an email of `foo@bar.baz`.
`'*@bar.baz'`	with an email that ends with `@bar.baz`.

{# Fetch comments from users with a .co.uk domain on their email address #}
{% set comments = craft.comments.fetch()
    .email('*.co.uk')
    .all() %}

// Fetch comments from users with a .co.uk domain on their email address
$comments = \verbb\comments\elements\Comment::find()
    ->email('*.co.uk')
    ->all();

`fixedOrder`#

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

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

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

`hasDescendants`#

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

(This has the opposite effect of calling leaves.)

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

// Fetch comments that have descendants
$comments = \verbb\comments\elements\Comment::find()
    ->hasDescendants()
    ->all();

`id`#

Narrows the query results based on the comments’ IDs.

Possible values include:

Value	Fetches comments…
`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.

{# Fetch the comment by its ID #}
{% set comment = craft.comments.fetch()
    .id(1)
    .one() %}

// Fetch the comment by its ID
$comment = \verbb\comments\elements\Comment::find()
    ->id(1)
    ->one();

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 comments in reverse #}
{% set comments = craft.comments.fetch()
    .inReverse()
    .all() %}

// Fetch comments in reverse
$comments = \verbb\comments\elements\Comment::find()
    ->inReverse()
    ->all();

`isFlagged`#

Narrows the query results based on whether the comments have been flagged.

{# Fetch comments that are flagged #}
{% set comments = craft.comments.fetch()
    .isFlagged(true)
    .all() %}

// Fetch comments that are flagged
$comments = \verbb\comments\elements\Comment::find()
    ->isFlagged(true)
    ->all();

`leaves`#

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

(This has the opposite effect of calling hasDescendants.)

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

// Fetch comments that have no descendants
$comments = \verbb\comments\elements\Comment::find()
    ->leaves()
    ->all();

`level`#

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

Possible values include:

Value	Fetches comments…
`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.

{# Fetch comments positioned at level 3 or above #}
{% set comments = craft.comments.fetch()
    .level('>= 3')
    .all() %}

// Fetch comments positioned at level 3 or above
$comments = \verbb\comments\elements\Comment::find()
    ->level('>= 3')
    ->all();

`limit`#

Determines the number of comments that should be returned.

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

// Fetch up to 10 comments
$comments = \verbb\comments\elements\Comment::find()
    ->limit(10)
    ->all();

`nextSiblingOf`#

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

Possible values include:

Value	Fetches the comment…
`1`	after the comment with an ID of 1.
a Comment object	after the comment represented by the object.

{# Fetch the next comment #}
{% set comment = craft.comments.fetch()
    .nextSiblingOf(comment)
    .one() %}

// Fetch the next comment
$comment = \verbb\comments\elements\Comment::find()
    ->nextSiblingOf($comment)
    ->one();

`offset`#

Determines how many comments should be skipped in the results.

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

// Fetch all comments except for the first 3
$comments = \verbb\comments\elements\Comment::find()
    ->offset(3)
    ->all();

`orderBy`#

Determines the order that the comments should be returned in. You can also use votes to order by the total number of votes.

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

// Fetch all comments in order of date created
$comments = \verbb\comments\elements\Comment::find()
    ->orderBy('elements.dateCreated asc')
    ->all();

`owner`#

Sets the ownerId and siteId parameters based on a given element.

{# Fetch comments created for this entry #}
{% set comments = craft.comments.fetch()
    .owner(entry)
    .all() %}

// Fetch comments created for this entry
$comments = \verbb\comments\elements\Comment::find()
    ->owner($entry)
    ->all();

`ownerId`#

Narrows the query results based on the owner element of the comment, per the owners’ IDs.

Possible values include:

Value	Fetches comments…
`1`	created for an element with an ID of 1.
`'not 1'`	not created for an element with an ID of 1.
`[1, 2]`	created for an element with an ID of 1 or 2.
`['not', 1, 2]`	not created for an element with an ID of 1 or 2.

{# Fetch comments created for an element with an ID of 1 #}
{% set comments = craft.comments.fetch()
    .ownerId(1)
    .all() %}

// Fetch comments created for an element with an ID of 1
$comments = \verbb\comments\elements\Comment::find()
    ->ownerId(1)
    ->all();

`ownerSection`#

Return comments for a specific entry section.

{# Fetch comments for specific entry section #}
{% set comments = craft.comments.fetch()
    .section(['news', 'blog'])
    .all() %}

// Fetch comments for specific entry section
$comments = \verbb\comments\elements\Comment::find()
    ->section(['news', 'blog'])
    ->all();

`ownerSectionId`#

Return comments for a specific entry sectionId.

{# Fetch comments for specific entry section #}
{% set comments = craft.comments.fetch()
    .sectionId(22)
    .all() %}

// Fetch comments for specific entry section
$comments = \verbb\comments\elements\Comment::find()
    ->section(22)
    ->all();

`ownerType`#

Return comments for a specific owner type - for instance, just for Entries (opens new window). Requires the full namespaced element class.

{# Fetch comments for specific element type #}
{% set comments = craft.comments.fetch()
    .ownerType('craft\\elements\\Entry')
    .all() %}

// Fetch comments for specific element type
$comments = \verbb\comments\elements\Comment::find()
    ->ownerType(craft\elements\Entry::class)
    ->all();

`positionedAfter`#

Narrows the query results to only comments that are positioned after another comment.

Possible values include:

Value	Fetches comments…
`1`	after the comment with an ID of 1.
a Comment object	after the comment represented by the object.

{# Fetch comments after this one #}
{% set comments = craft.comments.fetch()
    .positionedAfter(comment)
    .all() %}

// Fetch comments after this one
$comments = \verbb\comments\elements\Comment::find()
    ->positionedAfter($comment)
    ->all();

`positionedBefore`#

Narrows the query results to only comments that are positioned before another comment.

Possible values include:

Value	Fetches comments…
`1`	before the comment with an ID of 1.
a Comment object	before the comment represented by the object.

{# Fetch comments before this one #}
{% set comments = craft.comments.fetch()
    .positionedBefore(comment)
    .all() %}

// Fetch comments before this one
$comments = \verbb\comments\elements\Comment::find()
    ->positionedBefore($comment)
    ->all();

`prevSiblingOf`#

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

Possible values include:

Value	Fetches the comment…
`1`	before the comment with an ID of 1.
a Comment object	before the comment represented by the object.

{# Fetch the previous comment #}
{% set comment = craft.comments.fetch()
    .prevSiblingOf(comment)
    .one() %}

// Fetch the previous comment
$comment = \verbb\comments\elements\Comment::find()
    ->prevSiblingOf($comment)
    ->one();

`search`#

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

See Searching (opens new window) 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 comments that match the search query #}
{% set comments = craft.comments.fetch()
    .search(searchQuery)
    .all() %}

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

// Fetch all comments that match the search query
$comments = \verbb\comments\elements\Comment::find()
    ->search($searchQuery)
    ->all();

`siblingOf`#

Narrows the query results to only comments that are siblings of another comment.

Possible values include:

Value	Fetches comments…
`1`	beside the comment with an ID of 1.
a Comment object	beside the comment represented by the object.

{# Fetch comments beside this one #}
{% set comments = craft.comments.fetch()
    .siblingOf(comment)
    .all() %}

// Fetch comments beside this one
$comments = \verbb\comments\elements\Comment::find()
    ->siblingOf($comment)
    ->all();

`status`#

Narrows the query results based on the comments’ statuses.

Possible values include:

Value	Fetches comments…
`'approved'` (default)	that are approved.
`'pending'`	that are pending.
`'spam'`	that are marked as spam.
`'trashed'`	that are trashed (not deleted).
`['approved', 'pending']`	that are approved or pending.

{# Fetch pending comments #}
{% set comments = {twig-function}
    .status('pending')
    .all() %}

// Fetch pending comments
$comments = \verbb\comments\elements\Comment::find()
    ->status('pending')
    ->all();

`uid`#

Narrows the query results based on the comments’ UIDs.

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

// Fetch the comment by its UID
$comment = \verbb\comments\elements\Comment::find()
    ->uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    ->one();

`userId`#

Narrows the query results based on the user, per their ID.

Possible values include:

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

{# Fetch the current user's comments #}
{% set comments = craft.comments.fetch()
    .userId(currentUser.id)
    .all() %}

// Fetch the current user's comments
$user = Craft::$app->getUser()->getIdentity();

$comments = \verbb\comments\elements\Comment::find()
    ->userId($user->id)
    ->all();

Previous ← Custom Fields Next Comment →

Example
Parameters
after
ancestorDist
ancestorOf
anyStatus
asArray
before
commentDate
dateCreated
dateUpdated
descendantDist
descendantOf
email
fixedOrder
hasDescendants
id
inReverse
isFlagged
leaves
level
limit
nextSiblingOf
offset
orderBy
owner
ownerId
ownerSection
ownerSectionId
ownerType
positionedAfter
positionedBefore
prevSiblingOf
search
siblingOf
status
uid
userId

Get started with Comments

Available for Craft 4. Get it from the plugin store.

Explore the Docs Plugin Store

Get Started

Feature Tour

Template Guides

Getting Elements

Developers

Support

​Comment Queries#

​Example#

​Parameters#

​after#

​ancestorDist#

​ancestorOf#

​anyStatus#

​asArray#

​before#

​commentDate#

​dateCreated#

​dateUpdated#

​descendantDist#

​descendantOf#

​email#

​fixedOrder#

​hasDescendants#

​id#

​inReverse#

​isFlagged#

​leaves#

​level#

​limit#

​nextSiblingOf#

​offset#

​orderBy#

​owner#

​ownerId#

​ownerSection#

​ownerSectionId#

​ownerType#

​positionedAfter#

​positionedBefore#

​prevSiblingOf#

​search#

​siblingOf#

​status#

​uid#

​userId#

On this page

Get started with Comments

Comment Queries#

Example#

Parameters#

`after`#

`ancestorDist`#

`ancestorOf`#

`anyStatus`#

`asArray`#

`before`#

`commentDate`#

`dateCreated`#

`dateUpdated`#

`descendantDist`#

`descendantOf`#

`email`#

`fixedOrder`#

`hasDescendants`#

`id`#

`inReverse`#

`isFlagged`#

`leaves`#

`level`#

`limit`#

`nextSiblingOf`#

`offset`#

`orderBy`#

`owner`#

`ownerId`#

`ownerSection`#

`ownerSectionId`#

`ownerType`#

`positionedAfter`#

`positionedBefore`#

`prevSiblingOf`#

`search`#

`siblingOf`#

`status`#

`uid`#

`userId`#