ElementQuery

Type
Class
Namespace
craft\elements\db
Inherits
craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
craft\elements\db\ElementQueryInterface, yii\base\Configurable (opens new window), yii\db\ExpressionInterface (opens new window), yii\db\QueryInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\db\QueryTrait (opens new window)
Extended by
craft\elements\db\AssetQuery, craft\elements\db\CategoryQuery, craft\elements\db\EntryQuery, craft\elements\db\GlobalSetQuery, craft\elements\db\MatrixBlockQuery, craft\elements\db\TagQuery, craft\elements\db\UserQuery, craft\test\mockclasses\elements\MockElementQuery
Since
3.0.0

ElementQuery represents a SELECT SQL statement for elements in a way that is independent of DBMS.

View source (opens new window)

# Public Properties

Property Description
ancestorDist integer (opens new window), null (opens new window) – The maximum number of levels that results may be separated from ancestorOf().
ancestorOf integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that results must be an ancestor of.
archived boolean (opens new window) – Whether to return only archived elements.
asArray boolean (opens new window) – Whether to return each element as an array.
behaviors (opens new window) yii\base\Behavior (opens new window) – List of behaviors attached to this component
cachedResult craft\base\ElementInterface[], null (opens new window) – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTable string (opens new window), null (opens new window) – The content table that will be joined by this query.
criteria array (opens new window)
customFields craft\base\FieldInterface[], null (opens new window) – The fields that may be involved in this query.
dateCreated mixed – When the resulting elements must have been created.
dateUpdated mixed – When the resulting elements must have been last updated.
descendantDist integer (opens new window), null (opens new window) – The maximum number of levels that results may be separated from descendantOf().
descendantOf integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that results must be a descendant of.
distinct (opens new window) boolean (opens new window) – Whether to select distinct rows of data only.
draftCreator integer (opens new window), null (opens new window) – The drafts’ creator ID
draftId integer (opens new window), null (opens new window) – The ID of the draft to return (from the drafts table)
draftOf integer (opens new window), string (opens new window), false (opens new window), null (opens new window) – The source element ID that drafts should be returned for.
drafts boolean (opens new window) – Whether draft elements should be returned.
elementType string (opens new window), null (opens new window) – The name of the craft\base\ElementInterface class.
emulateExecution (opens new window) boolean (opens new window) – Whether to emulate the actual query execution, returning empty or false results.
enabledForSite boolean (opens new window) – Whether the elements must be enabled for the chosen site.
fixedOrder boolean (opens new window) – Whether results should be returned in the order specified by id().
from (opens new window) array (opens new window) – The table(s) to be selected from.
groupBy (opens new window) array (opens new window) – How to group the query results.
hasDescendants boolean (opens new window), null (opens new window) – Whether the resulting elements must have descendants.
having (opens new window) string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window) – The condition to be applied in the GROUP BY clause.
id integer (opens new window), integer (opens new window)[], false (opens new window), null (opens new window) – The element ID(s).
ignorePlaceholders boolean (opens new window) – Whether to ignore placeholder elements when populating the results.
inReverse boolean (opens new window) – Whether the results should be queried in reverse.
indexBy (opens new window) string (opens new window), callable (opens new window) – The name of the column by which the query results should be indexed by.
iterator ArrayIterator (opens new window)
join (opens new window) array (opens new window) – How to join with other tables.
leaves boolean (opens new window) – Whether the elements must be “leaves” in the structure.
level mixed – The element’s level within the structure
limit (opens new window) integer (opens new window), yii\db\ExpressionInterface (opens new window) – Maximum number of records to be returned.
nextSiblingOf integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that the result must be the next sibling of.
offset (opens new window) integer (opens new window), yii\db\ExpressionInterface (opens new window) – Zero-based offset from where the records are to be returned.
orderBy array (opens new window) – How to sort the query results.
params (opens new window) array (opens new window) – List of query parameter values indexed by parameter placeholders.
positionedAfter integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that the results must be positioned after.
positionedBefore integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that the results must be positioned before.
preferSites array (opens new window), null (opens new window) – Determines which site should be selected when querying multi-site elements.
prevSiblingOf integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that the result must be the previous sibling of.
query craft\db\Query, null (opens new window) – The query object created by prepare()
queryCacheDependency (opens new window) yii\caching\Dependency (opens new window) – The dependency to be associated with the cached query result for this query
queryCacheDuration (opens new window) integer (opens new window), true (opens new window) – The default number of seconds that query results can remain valid in cache.
rawSql string (opens new window)
ref string (opens new window), string (opens new window)[], null (opens new window) – The reference code(s) used to identify the element(s).
relatedTo integer (opens new window), array (opens new window), craft\base\ElementInterface, null (opens new window) – The element relation criteria.
revisionCreator integer (opens new window), null (opens new window) – The revisions’ creator ID
revisionId integer (opens new window), null (opens new window) – The ID of the revision to return (from the revisions table)
revisionOf integer (opens new window), null (opens new window) – The source element ID that revisions should be returned for
revisions boolean (opens new window) – Whether revision elements should be returned.
search string (opens new window), array (opens new window), craft\search\SearchQuery, null (opens new window) – The search term to filter the resulting elements by.
select (opens new window) array (opens new window) – The columns being selected.
selectOption (opens new window) string (opens new window) – Additional option that should be appended to the 'SELECT' keyword.
siblingOf integer (opens new window), craft\base\ElementInterface, null (opens new window) – The element (or its ID) that the results must be a sibling of.
siteId integer (opens new window), integer (opens new window)[], string (opens new window), null (opens new window) – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
slug string (opens new window), string (opens new window)[], null (opens new window) – The slug that resulting elements must have.
status string (opens new window), string (opens new window)[], null (opens new window) – The status(es) that the resulting elements must have.
structureId integer (opens new window), false (opens new window), null (opens new window) – The structure ID that should be used to join in the structureelements table.
subQuery craft\db\Query, null (opens new window) – The subselect’s query object created by prepare()
tablesUsedInFrom (opens new window) string (opens new window)[] – Table names indexed by aliases
title string (opens new window), string (opens new window)[], null (opens new window) – The title that resulting elements must have.
trashed boolean (opens new window), null (opens new window) – Whether to return trashed (soft-deleted) elements.
uid string (opens new window), string (opens new window)[], null (opens new window) – The element UID(s).
union (opens new window) array (opens new window) – This is used to construct the UNION clause(s) in a SQL statement.
unique boolean (opens new window) – Whether only elements with unique IDs should be returned by the query.
uri string (opens new window), string (opens new window)[], null (opens new window) – The URI that the resulting element must have.
where (opens new window) string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window) – Query condition.
with string (opens new window), array (opens new window), null (opens new window) – The eager-loading declaration.
withQueries (opens new window) array (opens new window) – This is used to construct the WITH section in a SQL query.
withStructure boolean (opens new window), null (opens new window) – Whether element structure data should automatically be left-joined into the query.

# ancestorDist

Type
integer (opens new window), null (opens new window)
Default value
null

The maximum number of levels that results may be separated from ancestorOf().

View source (opens new window)

# ancestorOf

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that results must be an ancestor of.

View source (opens new window)

# archived

Type
boolean (opens new window)
Default value
false

Whether to return only archived elements.

View source (opens new window)

# asArray

Type
boolean (opens new window)
Default value
false

Whether to return each element as an array. If false (default), an object of elementType will be created to represent each element.

View source (opens new window)

# cachedResult

Type
craft\base\ElementInterface[], null (opens new window)
Default value
null

$elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed

View source (opens new window)

# contentTable

Type
string (opens new window), null (opens new window)
Default value
\craft\db\Table::CONTENT

The content table that will be joined by this query.

View source (opens new window)

# criteria

Type
array (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# customFields

Type
craft\base\FieldInterface[], null (opens new window)
Default value
null

The fields that may be involved in this query.

View source (opens new window)

# dateCreated

Type
mixed
Default value
null

When the resulting elements must have been created.

View source (opens new window)

# dateUpdated

Type
mixed
Default value
null

When the resulting elements must have been last updated.

View source (opens new window)

# descendantDist

Type
integer (opens new window), null (opens new window)
Default value
null

The maximum number of levels that results may be separated from descendantOf().

View source (opens new window)

# descendantOf

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that results must be a descendant of.

View source (opens new window)

# draftCreator

Type
integer (opens new window), null (opens new window)
Default value
null
Since
3.2.0

The drafts’ creator ID

View source (opens new window)

# draftId

Type
integer (opens new window), null (opens new window)
Default value
null
Since
3.2.0

The ID of the draft to return (from the drafts table)

View source (opens new window)

# draftOf

Type
integer (opens new window), string (opens new window), false (opens new window), null (opens new window)
Default value
null
Since
3.2.0

The source element ID that drafts should be returned for.

This can be set to one of the following:

  • A source element ID – matches drafts of that element
  • '*' – matches drafts of any source element
  • false – matches unsaved drafts that have no source element

View source (opens new window)

# drafts

Type
boolean (opens new window)
Default value
false
Since
3.2.0

Whether draft elements should be returned.

View source (opens new window)

# elementType

Type
string (opens new window), null (opens new window)
Default value
null

The name of the craft\base\ElementInterface class.

View source (opens new window)

# enabledForSite

DEPRECATED

Deprecated in 3.5.0

Type
boolean (opens new window)
Default value
false

Whether the elements must be enabled for the chosen site.

View source (opens new window)

# fixedOrder

Type
boolean (opens new window)
Default value
false

Whether results should be returned in the order specified by id().

View source (opens new window)

# hasDescendants

Type
boolean (opens new window), null (opens new window)
Default value
null
Since
3.0.4

Whether the resulting elements must have descendants.

View source (opens new window)

# id

Type
integer (opens new window), integer (opens new window)[], false (opens new window), null (opens new window)
Default value
null

The element ID(s). Prefix IDs with 'not ' to exclude them.

View source (opens new window)

# ignorePlaceholders

Type
boolean (opens new window)
Default value
false
Since
3.2.9

Whether to ignore placeholder elements when populating the results.

View source (opens new window)

# inReverse

Type
boolean (opens new window)
Default value
false

Whether the results should be queried in reverse.

View source (opens new window)

# iterator

Type
ArrayIterator (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# leaves

Type
boolean (opens new window)
Default value
false

Whether the elements must be “leaves” in the structure.

View source (opens new window)

# level

Type
mixed
Default value
null

The element’s level within the structure

View source (opens new window)

# nextSiblingOf

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that the result must be the next sibling of.

View source (opens new window)

# orderBy

Type
array (opens new window)
Default value
''

How to sort the query results. This is used to construct the ORDER BY clause in a SQL statement. The array keys are the columns to be sorted by, and the array values are the corresponding sort directions which can be either SORT_ASC (opens new window) or SORT_DESC (opens new window). The array may also contain yii\db\ExpressionInterface (opens new window) objects. If that is the case, the expressions will be converted into strings without any change.

View source (opens new window)

# positionedAfter

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that the results must be positioned after.

View source (opens new window)

# positionedBefore

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that the results must be positioned before.

View source (opens new window)

# preferSites

Type
array (opens new window), null (opens new window)
Default value
false
Since
3.2.0

Determines which site should be selected when querying multi-site elements.

View source (opens new window)

# prevSiblingOf

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that the result must be the previous sibling of.

View source (opens new window)

# query

Type
craft\db\Query, null (opens new window)
Default value
null

The query object created by prepare()

See also prepare()

View source (opens new window)

# ref

Type
string (opens new window), string (opens new window)[], null (opens new window)
Default value
null

The reference code(s) used to identify the element(s).

This property is set when accessing elements via their reference tags, e.g. {entry:section/slug}.

View source (opens new window)

# relatedTo

Type
integer (opens new window), array (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element relation criteria.

See Relations (opens new window) for supported syntax options.

View source (opens new window)

# revisionCreator

Type
integer (opens new window), null (opens new window)
Default value
null
Since
3.2.0

The revisions’ creator ID

View source (opens new window)

# revisionId

Type
integer (opens new window), null (opens new window)
Default value
null
Since
3.2.0

The ID of the revision to return (from the revisions table)

View source (opens new window)

# revisionOf

Type
integer (opens new window), null (opens new window)
Default value
null
Since
3.2.0

The source element ID that revisions should be returned for

View source (opens new window)

# revisions

Type
boolean (opens new window)
Default value
false
Since
3.2.0

Whether revision elements should be returned.

View source (opens new window)

Type
string (opens new window), array (opens new window), craft\search\SearchQuery, null (opens new window)
Default value
null

The search term to filter the resulting elements by.

See Searching (opens new window) for supported syntax options.

View source (opens new window)

# siblingOf

Type
integer (opens new window), craft\base\ElementInterface, null (opens new window)
Default value
null

The element (or its ID) that the results must be a sibling of.

View source (opens new window)

# siteId

Type
integer (opens new window), integer (opens new window)[], string (opens new window), null (opens new window)
Default value
null

The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.

View source (opens new window)

# slug

Type
string (opens new window), string (opens new window)[], null (opens new window)
Default value
null

The slug that resulting elements must have.

View source (opens new window)

# status

Type
string (opens new window), string (opens new window)[], null (opens new window)
Default value
[\craft\base\Element::STATUS_ENABLED]

The status(es) that the resulting elements must have.

View source (opens new window)

# structureId

Type
integer (opens new window), false (opens new window), null (opens new window)
Default value
null

The structure ID that should be used to join in the structureelements table.

View source (opens new window)

# subQuery

Type
craft\db\Query, null (opens new window)
Default value
null

The subselect’s query object created by prepare()

See also prepare()

View source (opens new window)

# title

Type
string (opens new window), string (opens new window)[], null (opens new window)
Default value
null

The title that resulting elements must have.

View source (opens new window)

# trashed

Type
boolean (opens new window), null (opens new window)
Default value
false
Since
3.1.0

Whether to return trashed (soft-deleted) elements. If this is set to null, then both trashed and non-trashed elements will be returned.

View source (opens new window)

# uid

Type
string (opens new window), string (opens new window)[], null (opens new window)
Default value
null

The element UID(s). Prefix UIDs with 'not ' to exclude them.

View source (opens new window)

# unique

Type
boolean (opens new window)
Default value
false
Since
3.2.0

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

View source (opens new window)

# uri

Type
string (opens new window), string (opens new window)[], null (opens new window)
Default value
null

The URI that the resulting element must have.

View source (opens new window)

# with

Type
string (opens new window), array (opens new window), null (opens new window)
Default value
null

The eager-loading declaration.

See Eager-Loading Elements (opens new window) for supported syntax options.

View source (opens new window)

# withStructure

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether element structure data should automatically be left-joined into the query.

View source (opens new window)

# Protected Properties

Property Description
defaultOrderBy array (opens new window) – The default orderBy() value to use if orderBy() is empty but not null.

# defaultOrderBy

Type
array (opens new window)
Default value
['elements.dateCreated' => SORT_DESC]

The default orderBy() value to use if orderBy() is empty but not null.

View source (opens new window)

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct() Constructor
__get() Returns the value of a component property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets the value of a component property.
__toString() (opens new window) Returns the SQL representation of Query
__unset() (opens new window) Sets an object property to null.
addGroupBy() (opens new window) Adds additional group-by columns to the existing ones.
addOrderBy() Adds additional ORDER BY columns to the query.
addParams() (opens new window) Adds additional parameters to be bound to the query.
addSelect() (opens new window) Add more columns to the SELECT part of the query.
all() Executes the query and returns all results as an array.
ancestorDist() Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf().
ancestorOf() Narrows the query results to only {elements} that are ancestors of another {element}.
andFilterCompare() (opens new window) Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving() (opens new window) Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window).
andFilterWhere() (opens new window) Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window).
andHaving() (opens new window) Adds an additional HAVING condition to the existing one.
andWhere() (opens new window) Adds an additional WHERE condition to the existing one.
andWith() Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with().
anyStatus() Removes element filters based on their statuses.
archived() Sets the archived property.
asArray() Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects.
attachBehavior() (opens new window) Attaches a behavior to this component.
attachBehaviors() (opens new window) Attaches a list of behaviors to the component.
average() (opens new window) Returns the average of the specified column values.
batch() (opens new window) Starts a batch query.
behaviors() Returns a list of behaviors that this component should behave as.
cache() (opens new window) Enables query cache for this Query.
canGetProperty() (opens new window) Returns a value indicating whether a property can be read.
canSetProperty() (opens new window) Returns a value indicating whether a property can be set.
className() (opens new window) Returns the fully qualified name of this class.
clearCachedResult() Clears the cached result.
column() Executes the query and returns the first column of the result.
count() Returns the number of records.
create() (opens new window) Creates a new Query object and copies its property values from an existing one.
createCommand() (opens new window) Creates a DB command that can be used to execute this query.
criteriaAttributes() Returns the query's criteria attributes.
dateCreated() Narrows the query results based on the {elements}’ creation dates.
dateUpdated() Narrows the query results based on the {elements}’ last-updated dates.
descendantDist() Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf().
descendantOf() Narrows the query results to only {elements} that are descendants of another {element}.
detachBehavior() (opens new window) Detaches a behavior from the component.
detachBehaviors() (opens new window) Detaches all behaviors from the component.
distinct() (opens new window) Sets the value indicating whether to SELECT DISTINCT or not.
draftCreator() Narrows the query results to only drafts created by a given user.
draftId() Narrows the query results based on the {elements}’ draft’s ID (from the drafts table).
draftOf() Narrows the query results to only drafts of a given {element}.
drafts() Narrows the query results to only drafts {elements}.
each() (opens new window) Starts a batch query and retrieves data row by row.
emulateExecution() (opens new window) Sets whether to emulate query execution, preventing any interaction with data storage.
enabledForSite() Narrows the query results based on whether the {elements} are enabled in the site they’re being queried in, per the site() parameter.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exists() Returns a value indicating whether the query result contains any row of data.
extraFields() (opens new window) Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
fields() Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
filterHaving() (opens new window) Sets the HAVING part of the query but ignores empty operands (opens new window).
filterWhere() (opens new window) Sets the WHERE part of the query but ignores empty operands (opens new window).
find() Returns all elements that match the criteria.
first() Returns the first element that matches the criteria.
fixedOrder() Causes the query results to be returned in the order specified by id().
from() (opens new window) Sets the FROM part of the query.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getCachedResult() Returns the resulting elements set by setCachedResult(), if the criteria params haven’t changed since then.
getCriteria() Returns an array of the current criteria attribute values.
getIterator() Required by the IteratorAggregate interface.
getRawSql() Shortcut for createCommand()->getRawSql().
getTablesUsedInFrom() (opens new window) Returns table names used in from() (opens new window) indexed by aliases.
groupBy() (opens new window) Sets the GROUP BY part of the query.
hasDescendants() Narrows the query results based on whether the {elements} have any descendants.
hasEventHandlers() (opens new window) Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window) Returns a value indicating whether a method is defined.
hasProperty() (opens new window) Returns a value indicating whether a property is defined.
having() (opens new window) Sets the HAVING part of the query.
id() Narrows the query results based on the {elements}’ IDs.
ids() Executes the query and returns the IDs of the resulting elements.
ignorePlaceholders() Causes the query to return matching {elements} 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.
indexBy() (opens new window) Sets the indexBy() (opens new window) property.
init() Initializes the object.
innerJoin() (opens new window) Appends an INNER JOIN part to the query.
isJoined() Returns whether a given table has been joined in this query.
join() (opens new window) Appends a JOIN part to the query.
last() Returns the last element that matches the criteria.
leaves() Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants).
leftJoin() (opens new window) Appends a LEFT OUTER JOIN part to the query.
level() Narrows the query results based on the {elements}’ level within the structure.
limit() (opens new window) Determines the number of {elements} that should be returned.
locale() Sets the \craft\elements\db\$site property.
localeEnabled() Sets the enabledForSite property.
max() (opens new window) Returns the maximum of the specified column values.
min() (opens new window) Returns the minimum of the specified column values.
nextSiblingOf() Narrows the query results to only the {element} that comes immediately after another {element}.
noCache() (opens new window) Disables query cache for this Query.
nth() Executes the query and returns a single row of result at a given offset.
off() (opens new window) Detaches an existing event handler from this component.
offset() (opens new window) Determines how many {elements} should be skipped in the results.
offsetExists() Required by the ArrayAccess interface.
offsetGet() Required by the ArrayAccess interface.
offsetSet() Required by the ArrayAccess interface.
offsetUnset() Required by the ArrayAccess interface.
on() (opens new window) Attaches an event handler to an event.
one() Executes the query and returns a single row of result.
orFilterHaving() (opens new window) Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window).
orFilterWhere() (opens new window) Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window).
orHaving() (opens new window) Adds an additional HAVING condition to the existing one.
orWhere() (opens new window) Adds an additional WHERE condition to the existing one.
order() Sets the orderBy property.
orderBy() Sets the ORDER BY part of the query.
pairs() Executes the query and returns the first two columns in the results as key/value pairs.
params() (opens new window) Sets the parameters to be bound to the query.
populate() Converts the raw query results into the format as specified by this query.
positionedAfter() Narrows the query results to only {elements} that are positioned after another {element}.
positionedBefore() Narrows the query results to only {elements} that are positioned before another {element}.
preferSites() If unique() is set, this determines which site should be selected when querying multi-site elements.
prepare() Prepares for building SQL.
prevSiblingOf() Narrows the query results to only the {element} that comes immediately before another {element}.
ref() Narrows the query results based on a reference string.
relatedTo() Narrows the query results to only {elements} that are related to certain other elements.
revisionCreator() Narrows the query results to only revisions created by a given user.
revisionId() Narrows the query results based on the {elements}’ revision’s ID (from the revisions table).
revisionOf() Narrows the query results to only revisions of a given {element}.
revisions() Narrows the query results to only revision {elements}.
rightJoin() (opens new window) Appends a RIGHT OUTER JOIN part to the query.
scalar() Returns the query result as a scalar value.
search() Narrows the query results to only {elements} that match a search query.
select() (opens new window) Sets the SELECT part of the query.
setCachedResult() Sets the resulting elements.
siblingOf() Narrows the query results to only {elements} that are siblings of another {element}.
site() Determines which site(s) the {elements} should be queried in.
siteId() Determines which site(s) the {elements} should be queried in, per the site’s ID.
slug() Narrows the query results based on the {elements}’ slugs.
status() Narrows the query results based on the {elements}’ statuses.
structureId() Determines which structure data should be joined into the query.
sum() (opens new window) Returns the sum of the specified column values.
title() Narrows the query results based on the {elements}’ titles.
toArray() (opens new window) Converts the model into an array.
total() Returns the total elements that match the criteria.
trashed() Narrows the query results to only {elements} that have been soft-deleted.
trigger() (opens new window) Triggers an event.
uid() Narrows the query results based on the {elements}’ UIDs.
union() (opens new window) Appends a SQL statement using UNION operator.
unique() Determines whether only elements with unique IDs should be returned by the query.
uri() Narrows the query results based on the {elements}’ URIs.
where() (opens new window) Sets the WHERE part of the query.
with() Causes the query to return matching {elements} eager-loaded with related elements.
withQuery() (opens new window) Prepends a SQL statement using WITH syntax.
withStructure() Explicitly determines whether the query should join in the structure data.

# __call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

View source (opens new window)

Arguments

Returns

mixed – The method return value

Throws

# __construct()

Constructor

View source (opens new window)

Arguments

# __get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

View source (opens new window)

Arguments

Returns

mixed – The property value or the value of a behavior's property

Throws

# __isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

View source (opens new window)

Arguments

Returns

boolean (opens new window) – Whether the named property is set

# __set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

View source (opens new window)

Arguments

Throws

# addOrderBy()

Adds additional ORDER BY columns to the query.

View source (opens new window)

Arguments

The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface (opens new window) object can be passed to specify the ORDER BY part explicitly in plain SQL.

Returns

$this – The query object itself

# all()

Executes the query and returns all results as an array.

View source (opens new window)

Arguments

  • $db (yii\db\Connection (opens new window)) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

array (opens new window) – The query results. If the query results in nothing, an empty array will be returned.

# ancestorDist()

Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf().

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} above this one #}
{% set {elements-var} = {twig-method}
    .ancestorOf({myElement})
    .ancestorDist(3)
    .all() %}

# ancestorOf()

Narrows the query results to only {elements} that are ancestors of another {element}.

Possible values include:

Value Fetches {elements}…
1 above the {element} with an ID of 1.
a [[{element-class}]] object above the {element} represented by the object.

TIP

This can be combined with ancestorDist() if you want to limit how far away the ancestor {elements} can be.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} above this one #}
{% set {elements-var} = {twig-method}
    .ancestorOf({myElement})
    .all() %}

# andWith()

Since
3.0.9

Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with().

.

View source (opens new window)

Arguments

Returns

self – The query object itself

# anyStatus()

Since
3.0.17

Removes element filters based on their statuses.

View source (opens new window)

Returns

static – Self reference

Example

{# Fetch all {elements}, regardless of status #}
{% set {elements-var} = {twig-method}
    .anyStatus()
    .all() %}

# archived()

Sets the archived property.

View source (opens new window)

Arguments

Returns

static – Self reference

# asArray()

Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} as arrays #}
{% set {elements-var} = {twig-method}
    .asArray()
    .all() %}

# behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from \craft\elements\db\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() (opens new window) or be detached using detachBehavior() (opens new window). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

View source (opens new window)

Returns

array (opens new window) – The behavior configurations.

# clearCachedResult()

Since
3.4.0

Clears the cached result.

See also:

View source (opens new window)

# column()

Since
3.3.16.2

Executes the query and returns the first column of the result.

View source (opens new window)

Arguments

  • $db (yii\db\Connection (opens new window)) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

array (opens new window) – The first column of the query result. An empty array is returned if the query results in nothing.

# count()

Returns the number of records.

View source (opens new window)

Arguments

Returns

integer (opens new window), string (opens new window) – Number of records. The result may be a string depending on the underlying database engine and to support integer values higher than a 32bit PHP integer can handle.

# criteriaAttributes()

Returns the query's criteria attributes.

View source (opens new window)

Returns

string (opens new window)[]

# dateCreated()

Narrows the query results based on the {elements}’ creation dates.

Possible values include:

Value Fetches {elements}…
'>= 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.

View source (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{% set {elements-var} = {twig-method}
    .dateCreated(['and', ">= #{start}", "< #{end}"])
    .all() %}

# dateUpdated()

Narrows the query results based on the {elements}’ last-updated dates.

Possible values include:

Value Fetches {elements}…
'>= 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.

View source (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

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

{% set {elements-var} = {twig-method}
    .dateUpdated(">= #{lastWeek}")
    .all() %}

# descendantDist()

Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf().

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} below this one #}
{% set {elements-var} = {twig-method}
    .descendantOf({myElement})
    .descendantDist(3)
    .all() %}

# descendantOf()

Narrows the query results to only {elements} that are descendants of another {element}.

Possible values include:

Value Fetches {elements}…
1 below the {element} with an ID of 1.
a [[{element-class}]] object below the {element} represented by the object.

TIP

This can be combined with descendantDist() if you want to limit how far away the descendant {elements} can be.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} below this one #}
{% set {elements-var} = {twig-method}
    .descendantOf({myElement})
    .all() %}

# draftCreator()

Since
3.2.0

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\User object created by the user represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch drafts by the current user #}
{% set {elements-var} = {twig-method}
    .draftCreator(currentUser)
    .all() %}

# draftId()

Since
3.2.0

Narrows the query results based on the {elements}’ draft’s ID (from the drafts table).

Possible values include:

Value Fetches drafts…
1 for the draft with an ID of 1.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch a draft #}
{% set {elements-var} = {twig-method}
    .draftId(10)
    .all() %}

# draftOf()

Since
3.2.0

Narrows the query results to only drafts of a given {element}.

Possible values include:

Value Fetches drafts…
1 for the {element} with an ID of 1.
a [[{element-class}]] object for the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch drafts of the {element} #}
{% set {elements-var} = {twig-method}
    .draftOf({myElement})
    .all() %}

# drafts()

Since
3.2.0

Narrows the query results to only drafts {elements}.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch a draft {element} #}
{% set {elements-var} = {twig-function}
    .drafts()
    .id(123)
    .one() %}

# enabledForSite()

Narrows the query results based on whether the {elements} are enabled in the site they’re being queried in, per the site() parameter.

Possible values include:

Value Fetches {elements}…
true (default) that are enabled in the site.
false whether they are enabled or not in the site.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch all {elements}, including ones disabled for this site #}
{% set {elements-var} = {twig-method}
    .enabledForSite(false)
    .all() %}

# exists()

Returns a value indicating whether the query result contains any row of data.

View source (opens new window)

Arguments

  • $db (yii\db\Connection (opens new window)) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

boolean (opens new window) – Whether the query result contains any row of data.

# fields()

Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.

A field is a named element in the returned array by toArray() (opens new window). This method should return an array of field names or field definitions. If the former, the field name will be treated as an object property name whose value will be used as the field value. If the latter, the array key should be the field name while the array value should be the corresponding field definition which can be either an object property name or a PHP callable returning the corresponding field value. The signature of the callable should be:

function ($model, $field) {
    // return field value
}

For example, the following code declares four fields:

  • email: the field name is the same as the property name email;
  • firstName and lastName: the field names are firstName and lastName, and their values are obtained from the first_name and last_name properties;
  • fullName: the field name is fullName. Its value is obtained by concatenating first_name and last_name.
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

See also toArray() (opens new window) View source (opens new window)

Returns

array (opens new window) – The list of field names or field definitions.

# find()

DEPRECATED

Deprecated in Craft 3.0. Use all() instead.

Returns all elements that match the criteria.

View source (opens new window)

Arguments

Returns

craft\base\ElementInterface[] – The matched elements.

# first()

DEPRECATED

Deprecated in Craft 3.0. Use one() instead.

Returns the first element that matches the criteria.

View source (opens new window)

Arguments

Returns

craft\base\ElementInterface, null (opens new window)

# fixedOrder()

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} in a specific order #}
{% set {elements-var} = {twig-method}
    .id([1, 2, 3, 4, 5])
    .fixedOrder()
    .all() %}

# getCachedResult()

Returns the resulting elements set by setCachedResult(), if the criteria params haven’t changed since then.

See also setCachedResult() View source (opens new window)

Returns

craft\base\ElementInterface[], null (opens new window) – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed

# getCriteria()

Returns an array of the current criteria attribute values.

View source (opens new window)

Returns

array (opens new window)

# getIterator()

Required by the IteratorAggregate interface.

View source (opens new window)

Returns

ArrayIterator (opens new window)

# hasDescendants()

Since
3.0.4

Narrows the query results based on whether the {elements} have any descendants.

(This has the opposite effect of calling leaves().)

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} that have descendants #}
{% set {elements-var} = {twig-method}
    .hasDescendants()
    .all() %}

# id()

Narrows the query results based on the {elements}’ IDs.

Possible values include:

Value Fetches {elements}…
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.

TIP

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch the {element} by its ID #}
{% set {element-var} = {twig-method}
    .id(1)
    .one() %}

# ids()

Executes the query and returns the IDs of the resulting elements.

View source (opens new window)

Arguments

Returns

integer (opens new window)[] – The resulting element IDs. An empty array is returned if no elements are found.

# ignorePlaceholders()

Since
3.2.9

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

View source (opens new window)

Arguments

Returns

static – Self reference

# inReverse()

Causes the query results to be returned in reverse order.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} in reverse #}
{% set {elements-var} = {twig-method}
    .inReverse()
    .all() %}

# last()

DEPRECATED

Deprecated in Craft 3.0. Use nth() instead.

Returns the last element that matches the criteria.

View source (opens new window)

Arguments

Returns

craft\base\ElementInterface, null (opens new window)

# leaves()

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

(This has the opposite effect of calling hasDescendants().)

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} that have no descendants #}
{% set {elements-var} = {twig-method}
    .leaves()
    .all() %}

# level()

Narrows the query results based on the {elements}’ level within the structure.

Possible values include:

Value Fetches {elements}…
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.

View source (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} positioned at level 3 or above #}
{% set {elements-var} = {twig-method}
    .level('>= 3')
    .all() %}

# locale()

DEPRECATED

Deprecated in 3.0.0. Use site() or siteId() instead.

Sets the \craft\elements\db\$site property.

View source (opens new window)

Arguments

Returns

static – Self reference

# localeEnabled()

DEPRECATED

Deprecated in 3.0.0. status() should be used instead.

Sets the enabledForSite property.

View source (opens new window)

Arguments

  • $value (mixed) – The property value (defaults to true)

Returns

static – Self reference

# nextSiblingOf()

Narrows the query results to only the {element} that comes immediately after another {element}.

Possible values include:

Value Fetches the {element}…
1 after the {element} with an ID of 1.
a [[{element-class}]] object after the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch the next {element} #}
{% set {element-var} = {twig-method}
    .nextSiblingOf({myElement})
    .one() %}

# nth()

Executes the query and returns a single row of result at a given offset.

View source (opens new window)

Arguments

Returns

craft\base\ElementInterface, array (opens new window), null (opens new window) – The element. Null is returned if the query results in nothing.

# offsetExists()

Required by the ArrayAccess interface.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# offsetGet()

Required by the ArrayAccess interface.

View source (opens new window)

Arguments

Returns

mixed – The element at the given offset

# offsetSet()

Required by the ArrayAccess interface.

View source (opens new window)

Arguments

Throws

# offsetUnset()

Required by the ArrayAccess interface.

View source (opens new window)

Arguments

Throws

# one()

Executes the query and returns a single row of result.

View source (opens new window)

Arguments

  • $db (yii\db\Connection (opens new window)) – The database connection used to generate the SQL statement. If this parameter is not given, the db application component will be used.

Returns

craft\base\ElementInterface, array (opens new window), null (opens new window) – The first element. Null is returned if the query results in nothing.

# order()

DEPRECATED

Deprecated in Craft 3.0. Use orderBy() instead.

Sets the orderBy property.

View source (opens new window)

Arguments

Returns

static – Self reference

# orderBy()

Sets the ORDER BY part of the query.

View source (opens new window)

Arguments

The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface (opens new window) object can be passed to specify the ORDER BY part explicitly in plain SQL.

Returns

$this – The query object itself

# populate()

Converts the raw query results into the format as specified by this query.

This method is internally used to convert the data fetched from database into the format as required by this query.

View source (opens new window)

Arguments

Returns

craft\base\ElementInterface[], array (opens new window) – The resulting elements.

# positionedAfter()

Narrows the query results to only {elements} that are positioned after another {element}.

Possible values include:

Value Fetches {elements}…
1 after the {element} with an ID of 1.
a [[{element-class}]] object after the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} after this one #}
{% set {elements-var} = {twig-method}
    .positionedAfter({myElement})
    .all() %}

# positionedBefore()

Narrows the query results to only {elements} that are positioned before another {element}.

Possible values include:

Value Fetches {elements}…
1 before the {element} with an ID of 1.
a [[{element-class}]] object before the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} before this one #}
{% set {elements-var} = {twig-method}
    .positionedBefore({myElement})
    .all() %}

# preferSites()

Since
3.2.0

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.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# prepare()

Prepares for building SQL.

This method is called by \craft\elements\db\QueryBuilder when it starts to build SQL from a query object. You may override this method to do some final preparation work when converting a query into a SQL statement.

View source (opens new window)

Arguments

Returns

$this – A prepared query instance which will be used by \craft\elements\db\QueryBuilder to build the SQL

Throws

# prevSiblingOf()

Narrows the query results to only the {element} that comes immediately before another {element}.

Possible values include:

Value Fetches the {element}…
1 before the {element} with an ID of 1.
a [[{element-class}]] object before the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch the previous {element} #}
{% set {element-var} = {twig-method}
    .prevSiblingOf({myElement})
    .one() %}

# ref()

Narrows the query results based on a reference string.

View source (opens new window)

Arguments

Returns

static – Self reference

# relatedTo()

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

See Relations (opens new window) for a full explanation of how to work with this parameter.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch all {elements} that are related to myCategory #}
{% set {elements-var} = {twig-method}
    .relatedTo(myCategory)
    .all() %}

# revisionCreator()

Since
3.2.0

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\User object created by the user represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch revisions by the current user #}
{% set {elements-var} = {twig-method}
    .revisionCreator(currentUser)
    .all() %}

# revisionId()

Since
3.2.0

Narrows the query results based on the {elements}’ revision’s ID (from the revisions table).

Possible values include:

Value Fetches revisions…
1 for the revision with an ID of 1.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch a revision #}
{% set {elements-var} = {twig-method}
    .revisionId(10)
    .all() %}

# revisionOf()

Since
3.2.0

Narrows the query results to only revisions of a given {element}.

Possible values include:

Value Fetches revisions…
1 for the {element} with an ID of 1.
a [[{element-class}]] object for the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch revisions of the {element} #}
{% set {elements-var} = {twig-method}
    .revisionOf({myElement})
    .all() %}

# revisions()

Since
3.2.0

Narrows the query results to only revision {elements}.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch a revision {element} #}
{% set {elements-var} = {twig-function}
    .revisions()
    .id(123)
    .one() %}

Narrows the query results to only {elements} that match a search query.

See Searching (opens new window) for a full explanation of how to work with this parameter.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

{# Fetch all {elements} that match the search query #}
{% set {elements-var} = {twig-method}
    .search(searchQuery)
    .all() %}

# setCachedResult()

Sets the resulting elements.

If this is called, all() will return these elements rather than initiating a new SQL query, as long as none of the parameters have changed since setCachedResult() was called.

See also getCachedResult() View source (opens new window)

Arguments

# siblingOf()

Narrows the query results to only {elements} that are siblings of another {element}.

Possible values include:

Value Fetches {elements}…
1 beside the {element} with an ID of 1.
a [[{element-class}]] object beside the {element} represented by the object.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} beside this one #}
{% set {elements-var} = {twig-method}
    .siblingOf({myElement})
    .all() %}

# site()

Determines which site(s) the {elements} should be queried in.

The current site will be used by default.

Possible values include:

Value Fetches {elements}…
'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.

View source (opens new window)

Arguments

Returns

static – Self reference

Throws

Example

{# Fetch {elements} from the Foo site #}
{% set {elements-var} = {twig-method}
    .site('foo')
    .all() %}

# siteId()

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

The current site will be used by default.

Possible values include:

Value Fetches {elements}…
1 from the site with an ID of 1.
[1, 2] from a site with an ID of 1 or 2.
['not', 1, 2] not in a site with an ID of 1 or 2.
'*' from any site.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} from the site with an ID of 1 #}
{% set {elements-var} = {twig-method}
    .siteId(1)
    .all() %}

# slug()

Narrows the query results based on the {elements}’ slugs.

Possible values include:

Value Fetches {elements}…
'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.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Get the requested {element} slug from the URL #}
{% set requestedSlug = craft.app.request.getSegment(3) %}

{# Fetch the {element} with that slug #}
{% set {element-var} = {twig-method}
    .slug(requestedSlug|literal)
    .one() %}

# status()

Narrows the query results based on the {elements}’ statuses.

Possible values include:

Value Fetches {elements}…
'enabled' (default) that are enabled.
'disabled' that are disabled.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch disabled {elements} #}
{% set {elements-var} = {twig-method}
    .status('disabled')
    .all() %}

# structureId()

Determines which structure data should be joined into the query.

View source (opens new window)

Arguments

Returns

static – Self reference

# title()

Narrows the query results based on the {elements}’ titles.

Possible values include:

Value Fetches {elements}…
'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.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch {elements} with a title that contains "Foo" #}
{% set {elements-var} = {twig-method}
    .title('*Foo*')
    .all() %}

# total()

DEPRECATED

Deprecated in Craft 3.0. Use count() instead.

Returns the total elements that match the criteria.

View source (opens new window)

Arguments

Returns

integer (opens new window)

# trashed()

Since
3.1.0

Narrows the query results to only {elements} that have been soft-deleted.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch trashed {elements} #}
{% set {elements-var} = {twig-method}
    .trashed()
    .all() %}

# uid()

Narrows the query results based on the {elements}’ UIDs.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch the {element} by its UID #}
{% set {element-var} = {twig-method}
    .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    .one() %}

# unique()

Since
3.2.0

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.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch unique {elements} across all sites #}
{% set {elements-var} = {twig-method}
    .site('*')
    .unique()
    .all() %}

# uri()

Narrows the query results based on the {elements}’ URIs.

Possible values include:

Value Fetches {elements}…
'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.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

{# Fetch the {element} with that URI #}
{% set {element-var} = {twig-method}
    .uri(requestedUri|literal)
    .one() %}

# with()

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

See Eager-Loading Elements (opens new window) for a full explanation of how to work with this parameter.

View source (opens new window)

Arguments

Returns

self – The query object itself

Example

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

# withStructure()

Explicitly determines whether the query should join in the structure data.

View source (opens new window)

Arguments

Returns

static – Self reference

# Protected Methods

Method Description
afterPrepare() This method is called at the end of preparing an element query for the query builder.
beforePrepare() This method is called at the beginning of preparing an element query for the query builder.
cacheTags() Returns any cache invalidation tags that caches involving this element query should use as dependencies.
cleanUpTableNames() (opens new window) Clean up table names and aliases Both aliases and names are enclosed into .
customFields() Returns the fields that should take part in an upcoming elements query.
extractFieldsFor() (opens new window) Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() (opens new window) Extracts the root field names from nested fields.
filterCondition() (opens new window) Removes empty operands (opens new window) from the given query condition.
getUnaliasedColumnsFromSelect() (opens new window)
getUniqueColumns() (opens new window) Returns unique column names excluding duplicates.
isEmpty() (opens new window) Returns a value indicating whether the give value is "empty".
joinElementTable() Joins in a table with an id column that has a foreign key pointing to craft_elements.id.
normalizeOrderBy() Normalizes format of ORDER BY data.
normalizeSelect() (opens new window) Normalizes the SELECT columns passed to select() (opens new window) or addSelect() (opens new window).
queryScalar() Queries a scalar value by setting select() (opens new window) first.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
setCommandCache() (opens new window) Sets $command cache, if this query has enabled caching.
statusCondition() Returns the condition that should be applied to the element query for a given status.

# afterPrepare()

This method is called at the end of preparing an element query for the query builder.

It is called at the beginning of prepare(), right after query and subQuery have been created.

See also:

View source (opens new window)

Returns

boolean (opens new window) – Whether the query should be prepared and returned to the query builder. If false, the query will be cancelled and no results will be returned.

# beforePrepare()

This method is called at the beginning of preparing an element query for the query builder.

The main Query object being prepared for the query builder is available via query. The subselect’s Query object being prepared is available via subQuery. The role of the subselect query is to apply conditions to the query and narrow the result set down to just the elements that should actually be returned. The role of the main query is to join in any tables that should be included in the results, and select all of the columns that should be included in the results.

See also:

View source (opens new window)

Returns

boolean (opens new window) – Whether the query should be prepared and returned to the query builder. If false, the query will be cancelled and no results will be returned.

# cacheTags()

Since
3.5.0

Returns any cache invalidation tags that caches involving this element query should use as dependencies.

Use the most specific tag(s) possible, to reduce the likelihood of pointless cache clearing.

When elements are created/updated/deleted, their craft\base\ElementInterface::getCacheTags() method will be called, and any caches that have those tags listed as dependencies will be invalidated.

View source (opens new window)

Returns

string (opens new window)[]

# customFields()

Returns the fields that should take part in an upcoming elements query.

View source (opens new window)

Returns

craft\base\FieldInterface[] – The fields that should take part in the upcoming elements query

# joinElementTable()

Joins in a table with an id column that has a foreign key pointing to craft_elements.id.

View source (opens new window)

Arguments

  • $table (string (opens new window)) – The unprefixed table name. This will also be used as the table’s alias within the query.

# normalizeOrderBy()

Normalizes format of ORDER BY data.

View source (opens new window)

Arguments

Returns

array (opens new window)

# statusCondition()

Returns the condition that should be applied to the element query for a given status.

For example, if you support a status called “pending”, which maps back to a pending database column that will either be 0 or 1, this method could do this:

protected function statusCondition($status)
{
    switch ($status) {
        case 'pending':
            return ['mytable.pending' => 1];
        default:
            return parent::statusCondition($status);
    }

View source (opens new window)

Arguments

Returns

string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window), false (opens new window), null (opens new window) – The status condition, or false if $status is an unsupported status

# Events

# EVENT_AFTER_POPULATE_ELEMENT

Type
craft\events\PopulateElementEvent

The event that is triggered after an element is populated.

If craft\events\PopulateElementEvent::$element is replaced by an event handler, the replacement will be returned by createElement() instead.

# EVENT_AFTER_PREPARE

Type
\craft\elements\db\Event

An event that is triggered at the end of preparing an element query for the query builder.

# EVENT_BEFORE_PREPARE

Type
\craft\elements\db\Event

An event that is triggered at the beginning of preparing an element query for the query builder.