ElementQueryInterface

Type
Interface
Namespace
craft\elements\db
Extends
ArrayAccess, Countable, IteratorAggregate, yii\base\Arrayable, yii\db\QueryInterface
Implemented by
craft\elements\db\AssetQuery, craft\elements\db\CategoryQuery, craft\elements\db\ElementQuery, craft\elements\db\EntryQuery, craft\elements\db\GlobalSetQuery, craft\elements\db\MatrixBlockQuery, craft\elements\db\TagQuery, craft\elements\db\UserQuery
Since
3.0.0

ElementQueryInterface defines the common interface to be implemented by element query classes.

The default implementation of this interface is provided by craft\elements\db\ElementQuery.

View source

Public Methods

MethodDescription
addOrderBy()Adds additional ORDER BY columns to 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}.
andFilterWhere()Adds an additional WHERE condition to the existing one ignoring empty parameters.
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()Clears out the status() and enabledForSite() parameters.
archived()Sets the \craft\elements\db\$archived property.
asArray()Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects.
count()Returns the number of records.
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}.
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}.
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.
exists()Returns a value indicating whether the query result contains any row of data.
extraFields()Returns the list of additional fields that can be returned by toArray() in addition to those listed in fields().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
filterWhere()Sets the WHERE part of the query ignoring empty parameters.
fixedOrder()Causes the query results to be returned in the order specified by id().
hasDescendants()Narrows the query results based on whether the {elements} have any descendants.
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.
leaves()Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants).
level()Narrows the query results based on the {elements}’ level within the structure.
limit()Sets the LIMIT part of the query.
nextSiblingOf()Narrows the query results to only the {element} that comes immediately after another {element}.
nth()Executes the query and returns a single row of result at a given offset.
offset()Sets the OFFSET part of the query.
one()Executes the query and returns a single row of result.
orFilterWhere()Adds an additional WHERE condition to the existing one ignoring empty parameters.
orWhere()Adds an additional WHERE condition to the existing one.
orderBy()Sets the ORDER BY part of the 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.
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}.
search()Narrows the query results to only {elements} that match a search query.
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.
title()Narrows the query results based on the {elements}’ titles.
toArray()Converts the object into an array.
trashed()Narrows the query results to only {elements} that have been soft-deleted.
uid()Narrows the query results based on the {elements}’ UIDs.
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.
withStructure()Explicitly determines whether the query should join in the structure data.

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

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

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

ancestorOf()

Narrows the query results to only {elements} that are ancestors of another {element}. 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

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

Clears out the status() and enabledForSite() parameters.

View source

Returns

static – Self reference

Example

archived()

Sets the \craft\elements\db\$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

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

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

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

descendantOf()

Narrows the query results to only {elements} that are descendants of another {element}. 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

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

View source

Arguments

Returns

static – Self reference

Example

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

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.

View source

Arguments

Returns

static – Self reference

Example

drafts()

Since
3.2.0

Narrows the query results to only drafts {elements}.

View source

Arguments

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

Returns

static – Self reference

Example

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

fixedOrder()

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

View source

Arguments

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

Returns

static – Self reference

Example

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

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

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

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

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

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

nextSiblingOf()

Narrows the query results to only the {element} that comes immediately after another {element}. 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

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 or row of the query result. Null is returned if the query results in nothing.

one()

Executes the query and returns a single row of result.

View source

Arguments

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

Returns

craft\base\ElementInterface, array, null – The resulting element. Null is returned if the query results in nothing.

positionedAfter()

Narrows the query results to only {elements} that are positioned after another {element}. 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

positionedBefore()

Narrows the query results to only {elements} that are positioned before another {element}. 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

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

Arguments

Returns

static – Self reference

Example

prevSiblingOf()

Narrows the query results to only the {element} that comes immediately before another {element}. 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

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

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

View source

Arguments

Returns

static – Self reference

Example

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

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

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

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

siblingOf()

Narrows the query results to only {elements} that are siblings of another {element}. 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

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

Example

siteId()

Determines which site(s) the {elements} should be queried in, per the site’s ID. The current site will be used by default.

View source

Arguments

Returns

static – Self reference

Example

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

status()

Narrows the query results based on the {elements}’ statuses. Possible values include:

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

View source

Arguments

Returns

static – Self reference

Example

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

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

uid()

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

View source

Arguments

Returns

static – Self reference

Example

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

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

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

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