Craft 3 Class Reference

Appearance

ElementQuery ​

Type
Class
Namespace
craft\elements\db
Inherits
craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements
craft\elements\db\ElementQueryInterface, yii\base\Configurable, yii\db\ExpressionInterface, yii\db\QueryInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\db\QueryTrait
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

Public Properties ​

PropertyDescription
ancestorDistinteger, null – The maximum number of levels that results may be separated from ancestorOf().
ancestorOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of.
archivedboolean – Whether to return only archived elements.
asArrayboolean – Whether to return each element as an array.
behaviorsyii\base\Behavior – List of behaviors attached to this component.
cacheTagsstring[]
cachedResultcraft\base\ElementInterface[], null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTablestring, null – The content table that will be joined by this query.
criteriaarray
customFieldscraft\base\FieldInterface[], null – The fields that may be involved in this query.
dateCreatedmixed – When the resulting elements must have been created.
dateUpdatedmixed – When the resulting elements must have been last updated.
descendantDistinteger, null – The maximum number of levels that results may be separated from descendantOf().
descendantOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of.
distinctboolean – Whether to select distinct rows of data only.
draftCreatorinteger, null – The drafts’ creator ID
draftIdinteger, null – The ID of the draft to return (from the drafts table)
draftOfinteger, string, false, null – The source element ID that drafts should be returned for.
draftsboolean, null – Whether draft elements should be returned.
elementTypestring, null – The name of the craft\base\ElementInterface class.
emulateExecutionboolean – Whether to emulate the actual query execution, returning empty or false results.
enabledForSiteboolean – Whether the elements must be enabled for the chosen site.
fixedOrderboolean – Whether results should be returned in the order specified by id().
fromarray, null – The table(s) to be selected from.
groupByarray, null – How to group the query results.
hasDescendantsboolean, null – Whether the resulting elements must have descendants.
havingstring, array, yii\db\ExpressionInterface, null – The condition to be applied in the GROUP BY clause.
idinteger, integer[], false, null – The element ID(s).
ignorePlaceholdersboolean – Whether to ignore placeholder elements when populating the results.
inReverseboolean – Whether the results should be queried in reverse.
indexBystring, callable, null – The name of the column by which the query results should be indexed by.
iteratorArrayIterator
joinarray, null – How to join with other tables.
leavesboolean – Whether the elements must be “leaves” in the structure.
levelmixed – The element’s level within the structure
limitinteger, yii\db\ExpressionInterface, null – Maximum number of records to be returned.
nextSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of.
offsetinteger, yii\db\ExpressionInterface, null – Zero-based offset from where the records are to be returned.
orderByarray, null – How to sort the query results.
paramsarray, null – List of query parameter values indexed by parameter placeholders.
positionedAfterinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after.
positionedBeforeinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before.
preferSitesarray, null – Determines which site should be selected when querying multi-site elements.
prevSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of.
provisionalDraftsboolean, null – Whether provisional drafts should be returned.
querycraft\db\Query, null – The query object created by prepare()
queryCacheDependencyyii\caching\Dependency, null – The dependency to be associated with the cached query result for this query
queryCacheDurationinteger, boolean, null – The default number of seconds that query results can remain valid in cache.
rawSqlstring
refstring, string[], null – The reference code(s) used to identify the element(s).
relatedTointeger, array, craft\base\ElementInterface, null – The element relation criteria.
revisionCreatorinteger, null – The revisions’ creator ID
revisionIdinteger, null – The ID of the revision to return (from the revisions table)
revisionOfinteger, null – The source element ID that revisions should be returned for
revisionsboolean – Whether revision elements should be returned.
savedDraftsOnlyboolean – Whether only unpublished drafts which have been saved after initial creation should be included in the results.
searchstring, array, craft\search\SearchQuery, null – The search term to filter the resulting elements by.
selectarray, null – The columns being selected.
selectOptionstring, null – Additional option that should be appended to the 'SELECT' keyword.
siblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of.
sitestring, string[], craft\models\Site – The site(s) that resulting elements must be returned in
siteIdinteger, integer[], string, null – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
siteSettingsIdinteger, integer[], null – The element ID(s) in the elements_sites table.
slugstring, string[], null – The slug that resulting elements must have.
statusstring, string[], null – The status(es) that the resulting elements must have.
structureIdinteger, false, null – The structure ID that should be used to join in the structureelements table.
subQuerycraft\db\Query, null – The subselect’s query object created by prepare()
tablesUsedInFromstring[] – Table names indexed by aliases.
titlestring, string[], null – The title that resulting elements must have.
trashedboolean, null – Whether to return trashed (soft-deleted) elements.
uidstring, string[], null – The element UID(s).
unionarray, null – This is used to construct the UNION clause(s) in a SQL statement.
uniqueboolean – Whether only elements with unique IDs should be returned by the query.
uristring, string[], null – The URI that the resulting element must have.
wherestring, array, yii\db\ExpressionInterface, null – Query condition.
withstring, array, null – The eager-loading declaration.
withQueriesarray, null – This is used to construct the WITH section in a SQL query.
withStructureboolean, null – Whether element structure data should automatically be left-joined into the query.

ancestorDist ​

Type
integer, null
Default value
null

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

View source

ancestorOf ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

archived ​

Type
boolean
Default value
false

Whether to return only archived elements.

View source

asArray ​

Type
boolean
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

cacheTags ​

Type
string[]
Default value
null
Access
Read-only

View source

cachedResult ​

Type
craft\base\ElementInterface[], null
Default value
null

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

View source

contentTable ​

Type
string, null
Default value
\craft\db\Table::CONTENT

The content table that will be joined by this query.

View source

criteria ​

Type
array
Default value
null
Access
Read-only

View source

customFields ​

Type
craft\base\FieldInterface[], null
Default value
null

The fields that may be involved in this query.

View source

dateCreated ​

Type
mixed
Default value
null

When the resulting elements must have been created.

View source

dateUpdated ​

Type
mixed
Default value
null

When the resulting elements must have been last updated.

View source

descendantDist ​

Type
integer, null
Default value
null

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

View source

descendantOf ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

draftCreator ​

Type
integer, null
Default value
null
Since
3.2.0

The drafts’ creator ID

View source

draftId ​

Type
integer, null
Default value
null
Since
3.2.0

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

View source

draftOf ​

Type
integer, string, false, null
Default value
null
Since
3.2.0

The source element ID that drafts should be returned for.

View source

drafts ​

Type
boolean, null
Default value
false
Since
3.2.0

Whether draft elements should be returned.

View source

elementType ​

Type
string, null
Default value
null

The name of the craft\base\ElementInterface class.

View source

enabledForSite ​

DEPRECATED

Deprecated in 3.5.0

Type
boolean
Default value
false

Whether the elements must be enabled for the chosen site.

View source

fixedOrder ​

Type
boolean
Default value
false

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

View source

hasDescendants ​

Type
boolean, null
Default value
null
Since
3.0.4

Whether the resulting elements must have descendants.

View source

id ​

Type
integer, integer[], false, null
Default value
null

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

View source

ignorePlaceholders ​

Type
boolean
Default value
false
Since
3.2.9

Whether to ignore placeholder elements when populating the results.

View source

inReverse ​

Type
boolean
Default value
false

Whether the results should be queried in reverse.

View source

iterator ​

Type
ArrayIterator
Default value
null
Access
Read-only

View source

leaves ​

Type
boolean
Default value
false

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

View source

level ​

Type
mixed
Default value
null

The element’s level within the structure

View source

nextSiblingOf ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

orderBy ​

Type
array, null
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 or SORT_DESC. The array may also contain yii\db\ExpressionInterface objects. If that is the case, the expressions will be converted into strings without any change.

View source

positionedAfter ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

positionedBefore ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

preferSites ​

Type
array, null
Default value
false
Since
3.2.0

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

View source

prevSiblingOf ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

provisionalDrafts ​

Type
boolean, null
Default value
false
Since
3.7.0

Whether provisional drafts should be returned.

View source

query ​

Type
craft\db\Query, null
Default value
null

The query object created by prepare()

See also prepare()

View source

ref ​

Type
string, string[], null
Default value
null

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

View source

relatedTo ​

Type
integer, array, craft\base\ElementInterface, null
Default value
null

The element relation criteria.

View source

revisionCreator ​

Type
integer, null
Default value
null
Since
3.2.0

The revisions’ creator ID

View source

revisionId ​

Type
integer, null
Default value
null
Since
3.2.0

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

View source

revisionOf ​

Type
integer, null
Default value
null
Since
3.2.0

The source element ID that revisions should be returned for

View source

revisions ​

Type
boolean
Default value
false
Since
3.2.0

Whether revision elements should be returned.

View source

savedDraftsOnly ​

Type
boolean
Default value
false
Since
3.6.6

Whether only unpublished drafts which have been saved after initial creation should be included in the results.

View source

Type
string, array, craft\search\SearchQuery, null
Default value
null

The search term to filter the resulting elements by.

View source

siblingOf ​

Type
integer, craft\base\ElementInterface, null
Default value
null

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

View source

site ​

Type
string, string[], craft\models\Site
Default value
null

The site(s) that resulting elements must be returned in

View source

siteId ​

Type
integer, integer[], string, null
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

siteSettingsId ​

Type
integer, integer[], null
Default value
null
Since
3.7.0

The element ID(s) in the elements_sites table. Prefix IDs with 'not ' to exclude them.

View source

slug ​

Type
string, string[], null
Default value
null

The slug that resulting elements must have.

View source

status ​

Type
string, string[], null
Default value
[ \craft\base\Element::STATUS_ENABLED, ]

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

View source

structureId ​

Type
integer, false, null
Default value
null

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

View source

subQuery ​

Type
craft\db\Query, null
Default value
null

The subselect’s query object created by prepare()

See also prepare()

View source

title ​

Type
string, string[], null
Default value
null

The title that resulting elements must have.

View source

trashed ​

Type
boolean, null
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

uid ​

Type
string, string[], null
Default value
null

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

View source

unique ​

Type
boolean
Default value
false
Since
3.2.0

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

View source

uri ​

Type
string, string[], null
Default value
null

The URI that the resulting element must have.

View source

with ​

Type
string, array, null
Default value
null

The eager-loading declaration.

View source

withStructure ​

Type
boolean, null
Default value
null

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

View source

Protected Properties ​

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

defaultOrderBy ​

Type
array
Default value
[ 'elements.dateCreated' => SORT_DESC, ]

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

View source

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__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()Returns the SQL representation of Query
__unset()Sets a component property to be null.
addGroupBy()Adds additional group-by columns to the existing ones.
addOrderBy()Adds additional ORDER BY columns to the query.
addParams()Adds additional parameters to be bound to the query.
addSelect()Add more columns to the SELECT part of the query.
afterPopulate()Performs any post-population processing on elements.
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} in its structure.
andFilterCompare()Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving()Adds an additional HAVING condition to the existing one but ignores empty operands.
andFilterWhere()Adds an additional WHERE condition to the existing one but ignores empty operands.
andHaving()Adds an additional HAVING condition to the existing one.
andRelatedTo()Narrows the query results to only {elements} that are related to certain other elements.
andWhere()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()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
average()Returns the average of the specified column values.
batch()Starts a batch query.
behaviors()Returns a list of behaviors that this component should behave as.
cache()Enables query cache for this Query.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()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()Creates a new Query object and copies its property values from an existing one.
createCommand()Creates a DB command that can be used to execute this query.
createElement()Converts a found row into an element instance.
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} in its structure.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
distinct()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()Starts a batch query and retrieves data row by row.
emulateExecution()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()Makes sure that the behaviors declared in behaviors() are attached to this component.
exists()Returns a value indicating whether the query result contains any row of data.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
filterHaving()Sets the HAVING part of the query but ignores empty operands.
filterWhere()Sets the WHERE part of the query but ignores empty operands.
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()Sets the FROM part of the query.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCacheTags()
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()Returns table names used in from() indexed by aliases.
groupBy()Sets the GROUP BY part of the query.
hasDescendants()Narrows the query results based on whether the {elements} have any descendants in their structure.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
having()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()Sets the indexBy() property.
init()Initializes the object.
innerJoin()Appends an INNER JOIN part to the query.
isJoined()Returns whether a given table has been joined in this query.
join()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()Appends a LEFT OUTER JOIN part to the query.
level()Narrows the query results based on the {elements}’ level within the structure.
limit()Determines the number of {elements} that should be returned.
locale()Sets the site property.
localeEnabled()Sets the enabledForSite property.
max()Returns the maximum of the specified column values.
min()Returns the minimum of the specified column values.
nextSiblingOf()Narrows the query results to only the {element} that comes immediately after another {element} in its structure.
noCache()Disables query cache for this Query.
nth()Executes the query and returns a single row of result at a given offset.
off()Detaches an existing event handler from this component.
offset()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()Attaches an event handler to an event.
one()Executes the query and returns a single row of result.
orFilterHaving()Adds an additional HAVING condition to the existing one but ignores empty operands.
orFilterWhere()Adds an additional WHERE condition to the existing one but ignores empty operands.
orHaving()Adds an additional HAVING condition to the existing one.
orWhere()Adds an additional WHERE condition to the existing one.
order()Sets the orderBy property.
orderBy()Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by}.)
pairs()Executes the query and returns the first two columns in the results as key/value pairs.
params()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} in its structure.
positionedBefore()Narrows the query results to only {elements} that are positioned before another {element} in its structure.
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} in its structure.
provisionalDrafts()Narrows the query results to only provisional drafts.
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()Appends a RIGHT OUTER JOIN part to the query.
savedDraftsOnly()Narrows the query results to only unpublished drafts which have been saved after initial creation.
scalar()Returns the query result as a scalar value.
search()Narrows the query results to only {elements} that match a search query.
select()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} in its structure.
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.
siteSettingsId()Narrows the query results based on the {elements}’ IDs in the elements_sites table.
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()Returns the sum of the specified column values.
title()Narrows the query results based on the {elements}’ titles.
toArray()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()Triggers an event.
uid()Narrows the query results based on the {elements}’ UIDs.
union()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()Sets the WHERE part of the query.
with()Causes the query to return matching {elements} eager-loaded with related elements.
withQuery()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

Arguments ​

  • $name (string) – The method name
  • $params (array) – Method parameters

Returns ​

mixed – The method return value

Throws ​

__construct() ​

Constructor

View source

Arguments ​

  • $elementType (string) – The element type class associated with this query
  • $config (array) – Configurations to be applied to the newly created query object

__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

Arguments ​

  • $name (string) – The property name

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

Arguments ​

  • $name (string) – The property name or the event name

Returns ​

boolean – 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

Arguments ​

  • $name (string) – The property name or the event name
  • $value (mixed) – The property value

Throws ​

addOrderBy() ​

Adds additional ORDER BY columns to the query.

View source

Arguments ​

  • $columns (string, array, yii\db\ExpressionInterface) – The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. ['id' => SORT_ASC, 'name' => SORT_DESC]).

Returns ​

$this – The query object itself

afterPopulate() ​

Since
3.6.0

Performs any post-population processing on elements.

View source

Arguments ​

Returns ​

craft\base\ElementInterface[], array[]

all() ​

Executes the query and returns all results as an array.

View source

Arguments ​

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

Returns ​

array – 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

Arguments ​

Returns ​

static – Self reference

Example ​

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

ancestorOf() ​

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

Possible values include:

ValueFetches {elements}…
1above the {element} with an ID of 1.
a [[{element-class}]] objectabove 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

Arguments ​

Returns ​

static – Self reference

Example ​

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

andRelatedTo() ​

Since
3.6.11

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

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

View source

Arguments ​

Returns ​

static – Self reference

Throws ​

Example ​

twig
{# Fetch all {elements} that are related to myCategoryA and myCategoryB #}
{% set {elements-var} = {twig-method}
  .relatedTo(myCategoryA)
  .andRelatedTo(myCategoryB)
  .all() %}
php
// Fetch all {elements} that are related to $myCategoryA and $myCategoryB
${elements-var} = {php-method}
    ->relatedTo($myCategoryA)
    ->andRelatedTo($myCategoryB)
    ->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

Arguments ​

Returns ​

self – The query object itself

anyStatus() ​

Since
3.0.17

Removes element filters based on their statuses.

View source

Returns ​

static – Self reference

Example ​

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

archived() ​

Sets the archived property.

View source

Arguments ​

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

Returns ​

static – Self reference

asArray() ​

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

View source

Arguments ​

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

Returns ​

static – Self reference

Example ​

twig
{# Fetch {elements} as arrays #}
{% set {elements-var} = {twig-method}
  .asArray()
  .all() %}
php
// Fetch {elements} as arrays
${elements-var} = {php-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:

php
'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() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

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

View source

Returns ​

array – The behavior configurations.

cache() ​

Enables query cache for this Query.

View source

Arguments ​

  • $duration (integer, true) – The number of seconds that query results can remain valid in cache. Use 0 to indicate that the cached data will never expire. Use a negative number to indicate that query cache should not be used. Use boolean true to indicate that yii\db\Connection::$queryCacheDuration should be used. Defaults to true.
  • $dependency (yii\caching\Dependency, null) – The cache dependency associated with the cached result.

Returns ​

$this – The Query object itself

clearCachedResult() ​

Since
3.4.0

Clears the cached result.

See also:

View source

column() ​

Since
3.3.16.2

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

View source

Arguments ​

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

Returns ​

array – 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

Arguments ​

  • $q (string) – The COUNT expression. Defaults to '*'. Make sure you properly quote column names in the expression.
  • $db (yii\db\Connection, null) – The database connection used to generate the SQL statement. If this parameter is not given (or null), the db application component will be used.

Returns ​

integer, string, null – 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.

createElement() ​

Since
3.6.0

Converts a found row into an element instance.

View source

Arguments ​

Returns ​

craft\base\ElementInterface

criteriaAttributes() ​

Returns the query's criteria attributes.

View source

Returns ​

string[]

dateCreated() ​

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

Possible values include:

ValueFetches {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

Arguments ​

  • $value (mixed) – The property value

Returns ​

static – Self reference

Example ​

twig
{# 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() %}
php
// Fetch {elements} created last month
$start = (new \DateTime('first day of last month'))->format(\DateTime::ATOM);
$end = (new \DateTime('first day of this month'))->format(\DateTime::ATOM);

${elements-var} = {php-method}
    ->dateCreated(['and', ">= {$start}", "< {$end}"])
    ->all();

dateUpdated() ​

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

Possible values include:

ValueFetches {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

Arguments ​

  • $value (mixed) – The property value

Returns ​

static – Self reference

Example ​

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

{% set {elements-var} = {twig-method}
  .dateUpdated(">= #{lastWeek}")
  .all() %}
php
// Fetch {elements} updated in the last week
$lastWeek = (new \DateTime('1 week ago'))->format(\DateTime::ATOM);

${elements-var} = {php-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

Arguments ​

Returns ​

static – Self reference

Example ​

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

descendantOf() ​

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

Possible values include:

ValueFetches {elements}…
1below the {element} with an ID of 1.
a [[{element-class}]] objectbelow 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

Arguments ​

Returns ​

static – Self reference

Example ​

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

draftCreator() ​

Since
3.2.0

Narrows the query results to only drafts created by a given user.

Possible values include:

ValueFetches drafts…
1created by the user with an ID of 1.
a craft\elements\User objectcreated by the user represented by the object.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch drafts by the current user #}
{% set {elements-var} = {twig-method}
  .draftCreator(currentUser)
  .all() %}
php
// Fetch drafts by the current user
${elements-var} = {php-method}
    ->draftCreator(Craft::$app->user->identity)
    ->all();

draftId() ​

Since
3.2.0

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

Possible values include:

ValueFetches drafts…
1for the draft with an ID of 1.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

draftOf() ​

Since
3.2.0

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

Possible values include:

ValueFetches drafts…
1for the {element} with an ID of 1.
a [[{element-class}]] objectfor the {element} represented by the object.
'*'for any
falsethat aren’t associated with a published

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

drafts() ​

Since
3.2.0

Narrows the query results to only drafts {elements}.

View source

Arguments ​

  • $value (boolean, null) – The property value (defaults to true)

Returns ​

static – Self reference

Example ​

twig
{# Fetch a draft {element} #}
{% set {elements-var} = {twig-method}
  .drafts()
  .id(123)
  .one() %}
php
// Fetch a draft {element}
${elements-var} = {element-class}::find()
    ->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:

ValueFetches {elements}…
true (default)that are enabled in the site.
falsewhether they are enabled or not in the site.

View source

Arguments ​

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

Returns ​

static – Self reference

Example ​

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

exists() ​

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

View source

Arguments ​

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

Returns ​

boolean – Whether the query result contains any row of data.

fields() ​

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

A field is a named element in the returned array by toArray(). 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:

php
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.
php
return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

See also toArray()View source

Returns ​

array – 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

Arguments ​

  • $attributes (array, null) – Any last-minute parameters that should be added.

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

Arguments ​

Returns ​

craft\base\ElementInterface, null

fixedOrder() ​

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

TIP

If no IDs were passed to id(), setting this to true will result in an empty result set.

View source

Arguments ​

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

Returns ​

static – Self reference

Example ​

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

getCacheTags() ​

View source

Returns ​

string[]

getCachedResult() ​

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

See also setCachedResult()View source

Returns ​

craft\base\ElementInterface[], null – $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

Returns ​

array

getIterator() ​

Required by the IteratorAggregate interface.

View source

Returns ​

ArrayIterator

hasDescendants() ​

Since
3.0.4

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

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

View source

Arguments ​

  • $value (boolean) – The property value

Returns ​

static – Self reference

Example ​

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

id() ​

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

Possible values include:

ValueFetches {elements}…
1with an ID of 1.
'not 1'not with an ID of 1.
[1, 2]with an ID of 1 or 2.
['not', 1, 2]not with an ID of 1 or 2.

TIP

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

ids() ​

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

View source

Arguments ​

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

Returns ​

integer[] – 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

Arguments ​

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

Returns ​

static – Self reference

inReverse() ​

Causes the query results to be returned in reverse order.

View source

Arguments ​

  • $value (boolean) – The property value

Returns ​

static – Self reference

Example ​

twig
{# Fetch {elements} in reverse #}
{% set {elements-var} = {twig-method}
  .inReverse()
  .all() %}
php
// Fetch {elements} in reverse
${elements-var} = {php-method}
    ->inReverse()
    ->all();

last() ​

DEPRECATED

Deprecated in Craft 3.0. Use nth() instead.

Returns the last element that matches the criteria.

View source

Arguments ​

Returns ​

craft\base\ElementInterface, null

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

Arguments ​

  • $value (boolean) – The property value

Returns ​

static – Self reference

Example ​

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

level() ​

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

Possible values include:

ValueFetches {elements}…
1with a level of 1.
'not 1'not with a level of 1.
'>= 3'with a level greater than or equal to 3.
[1, 2]with a level of 1 or 2
['not', 1, 2]not with level of 1 or 2.

View source

Arguments ​

  • $value (mixed) – The property value

Returns ​

static – Self reference

Example ​

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

locale() ​

DEPRECATED

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

Sets the site property.

View source

Arguments ​

  • $value (string) – The property value

Returns ​

static – Self reference

localeEnabled() ​

DEPRECATED

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

Sets the enabledForSite property.

View source

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} in its structure.

Possible values include:

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

nth() ​

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

View source

Arguments ​

  • $n (integer) – The offset of the row to return. If offset() is set, $offset will be added to it.
  • $db (yii\db\Connection, null) – 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, null – The element. Null is returned if the query results in nothing.

offsetExists() ​

Required by the ArrayAccess interface.

View source

Arguments ​

Returns ​

boolean

offsetGet() ​

Required by the ArrayAccess interface.

View source

Arguments ​

Returns ​

mixed – The element at the given offset

offsetSet() ​

Required by the ArrayAccess interface.

View source

Arguments ​

  • $name (string) – The offset to set
  • $value (mixed) – The value

Throws ​

offsetUnset() ​

Required by the ArrayAccess interface.

View source

Arguments ​

  • $name (string) – The offset to unset

Throws ​

one() ​

Executes the query and returns a single row of result.

View source

Arguments ​

  • $db (yii\db\Connection, null) – 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, null – 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

Arguments ​

  • $value (string) – The property value

Returns ​

static – Self reference

orderBy() ​

Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by}.)

View source

Arguments ​

  • $columns (string, array, yii\db\ExpressionInterface, null) – The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. ['id' => SORT_ASC, 'name' => SORT_DESC]).

Returns ​

$this – The query object itself

Example ​

twig
{# Fetch all {elements} in order of date created #}
{% set {elements-var} = {twig-method}
  .orderBy('dateCreated ASC')
  .all() %}
php
// Fetch all {elements} in order of date created
${elements-var} = {php-method}
    ->orderBy('dateCreated ASC')
    ->all();

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

Arguments ​

  • $rows (array) – The raw query result from database

Returns ​

craft\base\ElementInterface[], array – The resulting elements.

positionedAfter() ​

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

Possible values include:

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

positionedBefore() ​

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

Possible values include:

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch {elements} before this one #}
{% set {elements-var} = {twig-method}
  .positionedBefore({myElement})
  .all() %}
php
// Fetch {elements} before this one
${elements-var} = {php-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 B, and Bar will be returned for Site C.

If this isn’t set, then preference goes to the current site.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# 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() %}
php
// Fetch unique {elements} from Site A, or Site B if they don’t exist in Site A
${elements-var} = {php-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

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} in its structure.

Possible values include:

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

provisionalDrafts() ​

Since
3.7.0

Narrows the query results to only provisional drafts.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch provisional drafts created by the current user #}
{% set {elements-var} = {twig-method}
  .provisionalDrafts()
  .draftCreator(currentUser)
  .all() %}
php
// Fetch provisional drafts created by the current user
${elements-var} = {php-method}
    ->provisionalDrafts()
    ->draftCreator(Craft::$app->user->identity)
    ->all();

ref() ​

Narrows the query results based on a reference string.

View source

Arguments ​

Returns ​

static – Self reference

relatedTo() ​

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

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

revisionCreator() ​

Since
3.2.0

Narrows the query results to only revisions created by a given user.

Possible values include:

ValueFetches revisions…
1created by the user with an ID of 1.
a craft\elements\User objectcreated by the user represented by the object.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch revisions by the current user #}
{% set {elements-var} = {twig-method}
  .revisionCreator(currentUser)
  .all() %}
php
// Fetch revisions by the current user
${elements-var} = {php-method}
    ->revisionCreator(Craft::$app->user->identity)
    ->all();

revisionId() ​

Since
3.2.0

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

Possible values include:

ValueFetches revisions…
1for the revision with an ID of 1.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch a revision #}
{% set {elements-var} = {twig-method}
  .revisionId(10)
  .all() %}
php
// Fetch a revision
${elements-var} = {php-method}
    ->revisionIf(10)
    ->all();

revisionOf() ​

Since
3.2.0

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

Possible values include:

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

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

revisions() ​

Since
3.2.0

Narrows the query results to only revision {elements}.

View source

Arguments ​

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

Returns ​

static – Self reference

Example ​

twig
{# Fetch a revision {element} #}
{% set {elements-var} = {twig-method}
  .revisions()
  .id(123)
  .one() %}
php
// Fetch a revision {element}
${elements-var} = {element-class}::find()
    ->revisions()
    ->id(123)
    ->one();

savedDraftsOnly() ​

Since
3.6.6

Narrows the query results to only unpublished drafts which have been saved after initial creation.

View source

Arguments ​

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

Returns ​

static – Self reference

Example ​

twig
{# Fetch saved, unpublished draft {elements} #}
{% set {elements-var} = {twig-method}
  .draftOf(false)
  .savedDraftsOnly()
  .all() %}
php
// Fetch saved, unpublished draft {elements}
${elements-var} = {element-class}::find()
    ->draftOf(false)
    ->savedDraftsOnly()
    ->all();

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

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# 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() %}
php
// Get the search query from the 'q' query string param
$searchQuery = \Craft::$app->request->getQueryParam('q');

// Fetch all {elements} that match the search query
${elements-var} = {php-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

Arguments ​

siblingOf() ​

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

Possible values include:

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch {elements} beside this one #}
{% set {elements-var} = {twig-method}
  .siblingOf({myElement})
  .all() %}
php
// Fetch {elements} beside this one
${elements-var} = {php-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:

ValueFetches {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 objectfrom 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

Arguments ​

Returns ​

static – Self reference

Throws ​

Example ​

twig
{# Fetch {elements} from the Foo site #}
{% set {elements-var} = {twig-method}
  .site('foo')
  .all() %}
php
// Fetch {elements} from the Foo site
${elements-var} = {php-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:

ValueFetches {elements}…
1from 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

Arguments ​

Returns ​

static – Self reference

Example ​

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

siteSettingsId() ​

Since
3.7.0

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

Possible values include:

ValueFetches {elements}…
1with an elements_sites ID of 1.
'not 1'not with an elements_sites ID of 1.
[1, 2]with an elements_sites ID of 1 or 2.
['not', 1, 2]not with an elements_sites ID of 1 or 2.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch the {element} by its ID in the elements_sites table #}
{% set {element-var} = {twig-method}
  .siteSettingsId(1)
  .one() %}
php
// Fetch the {element} by its ID in the elements_sites table
${element-var} = {php-method}
    ->siteSettingsId(1)
    ->one();

slug() ​

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

Possible values include:

ValueFetches {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

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# 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() %}
php
// Get the requested {element} slug from the URL
$requestedSlug = \Craft::$app->request->getSegment(3);

// Fetch the {element} with that slug
${element-var} = {php-method}
    ->slug(\craft\helpers\Db::escapeParam($requestedSlug))
    ->one();

status() ​

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

Possible values include:

ValueFetches {elements}…
'enabled' (default)that are enabled.
'disabled'that are disabled.
['not', 'disabled']that are not disabled.

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch disabled {elements} #}
{% set {elements-var} = {twig-method}
  .status('disabled')
  .all() %}
php
// Fetch disabled {elements}
${elements-var} = {php-method}
    ->status('disabled')
    ->all();

structureId() ​

Determines which structure data should be joined into the query.

View source

Arguments ​

Returns ​

static – Self reference

title() ​

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

Possible values include:

ValueFetches {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

Arguments ​

Returns ​

static – Self reference

Example ​

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

WARNING

String values with commas will be treated as arrays, unless they’ve been escaped with the literal filter.

:::

total() ​

DEPRECATED

Deprecated in Craft 3.0. Use count() instead.

Returns the total elements that match the criteria.

View source

Arguments ​

Returns ​

integer

trashed() ​

Since
3.1.0

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

View source

Arguments ​

  • $value (boolean, null) – The property value (defaults to true)

Returns ​

static – Self reference

Example ​

twig
{# Fetch trashed {elements} #}
{% set {elements-var} = {twig-method}
  .trashed()
  .all() %}
php
// Fetch trashed {elements}
${elements-var} = {element-class}::find()
    ->trashed()
    ->all();

uid() ​

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

View source

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# Fetch the {element} by its UID #}
{% set {element-var} = {twig-method}
  .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
  .one() %}
php
// Fetch the {element} by its UID
${element-var} = {php-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

Arguments ​

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

Returns ​

static – Self reference

Example ​

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

uri() ​

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

Possible values include:

ValueFetches {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

Arguments ​

Returns ​

static – Self reference

Example ​

twig
{# 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() %}
php
// Get the requested URI
$requestedUri = \Craft::$app->request->getPathInfo();

// Fetch the {element} with that URI
${element-var} = {php-method}
    ->uri(\craft\helpers\Db::escapeParam($requestedUri))
    ->one();

with() ​

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

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

View source

Arguments ​

Returns ​

self – The query object itself

Example ​

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

withStructure() ​

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

View source

Arguments ​

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

Returns ​

static – Self reference

Protected Methods ​

MethodDescription
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()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()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()Extracts the root field names from nested fields.
filterCondition()Removes empty operands from the given query condition.
getUnaliasedColumnsFromSelect()
getUniqueColumns()Returns unique column names excluding duplicates.
isEmpty()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()Normalizes the SELECT columns passed to select() or addSelect().
queryScalar()Queries a scalar value by setting select() first.
resolveFields()Determines which fields can be returned by toArray().
setCommandCache()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

Returns ​

boolean – 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

Returns ​

boolean – 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

Returns ​

string[]

customFields() ​

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

View source

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

Arguments ​

  • $table (string) – 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

Arguments ​

Returns ​

array

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:

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

View source

Arguments ​

  • $status (string) – The status

Returns ​

string, array, yii\db\ExpressionInterface, false, null – 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\events\CancelableEvent

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

EVENT_BEFORE_PREPARE ​

Type
craft\events\CancelableEvent

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