MatrixBlockQuery

Type

Class

Namespace

craft\elements\db

Inherits

craft\elements\db\MatrixBlockQuery » craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)

Implements

ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\elements\db\ElementQueryInterface, yii\base\Configurable (opens new window), yii\db\ExpressionInterface (opens new window), yii\db\QueryInterface (opens new window)

Uses traits

craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\db\QueryTrait (opens new window)

Since

3.0.0

MatrixBlockQuery represents a SELECT SQL statement for global sets in a way that is independent of DBMS.

View source (opens new window)

Public Properties

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

allowOwnerDrafts

Type

boolean (opens new window), null (opens new window)

Default value

null

Since

3.3.10

Whether the owner elements can be drafts.

View source (opens new window)

allowOwnerRevisions

Type

boolean (opens new window), null (opens new window)

Default value

null

Since

3.3.10

Whether the owner elements can be revisions.

View source (opens new window)

field

Type

string (opens new window), string (opens new window)[], craft\fields\Matrix, null (opens new window)

Default value

null

The field the Matrix blocks must belong to

View source (opens new window)

fieldId

Type

mixed

Default value

null

The field ID(s) that the resulting Matrix blocks must belong to.

View source (opens new window)

owner

Type

craft\base\ElementInterface

Default value

null

The owner element the Matrix blocks must belong to

View source (opens new window)

ownerId

Type

mixed

Default value

null

The owner element ID(s) that the resulting Matrix blocks must belong to.

View source (opens new window)

primaryOwner

Type

craft\base\ElementInterface

Default value

null

The primary owner element the Matrix blocks must belong to

View source (opens new window)

primaryOwnerId

Type

mixed

Default value

null

Since

4.0.0

The primary owner element ID(s) that the resulting Matrix blocks must belong to.

View source (opens new window)

type

Type

string (opens new window), string (opens new window)[], craft\models\MatrixBlockType, null (opens new window)

Default value

null

The block type(s) that resulting Matrix blocks must have

View source (opens new window)

typeId

Type

mixed

Default value

null

The block type ID(s) that the resulting Matrix blocks must have.

View source (opens new window)

Example

• PHP
• Twig

// fetch the entry’s text blocks
$blocks = $entry->myMatrixField
    ->type('text')
    ->all();

Protected Properties

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

defaultOrderBy

Type

array (opens new window)

Default value

[ 'matrixblocks_owners.sortOrder' => SORT_ASC, ]

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

View source (opens new window)

Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone()
__construct()	Constructor
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__toString() (opens new window)	Returns the SQL representation of Query
__unset() (opens new window)	Sets a component property to be null.
addGroupBy() (opens new window)	Adds additional group-by columns to the existing ones.
addOrderBy() (opens new window)	Adds additional ORDER BY columns to the query.
addParams() (opens new window)	Adds additional parameters to be bound to the query.
addSelect() (opens new window)	Add more columns to the SELECT part of the query.
afterPopulate()	Performs any post-population processing on elements.
all()
allowOwnerDrafts()	Narrows the query results based on whether the Matrix blocks’ owners are drafts.
allowOwnerRevisions()	Narrows the query results based on whether the Matrix blocks’ owners are revisions.
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() (opens new window)	Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving() (opens new window)	Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window).
andFilterWhere() (opens new window)	Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window).
andHaving() (opens new window)	Adds an additional HAVING condition to the existing one.
andRelatedTo()	Narrows the query results to only {elements} that are related to certain other elements.
andWhere() (opens new window)	Adds an additional WHERE condition to the existing one.
andWith()	Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with().
anyStatus()	Sets the status param to null.
archived()	Sets the archived property.
asArray()	Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
average() (opens new window)	Returns the average of the specified column values.
batch() (opens new window)	Starts a batch query.
behaviors()	Returns a list of behaviors that this component should behave as.
cache()	Enables query cache for this Query.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
clearCachedResult()	Clears the cached result (opens new window).
collect()	Executes the query and returns all results as a collection.
column()	Executes the query and returns the first column of the result.
count()	Returns the number of records.
create() (opens new window)	Creates a new Query object and copies its property values from an existing one.
createCommand() (opens new window)	Creates a DB command that can be used to execute this query.
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() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
distinct() (opens new window)	Sets the value indicating whether to SELECT DISTINCT or not.
draftCreator()	Narrows the query results to only drafts created by a given user.
draftId()	Narrows the query results based on the {elements}’ draft’s ID (from the drafts table).
draftOf()	Narrows the query results to only drafts of a given {element}.
drafts()	Narrows the query results to only drafts {elements}.
each() (opens new window)	Starts a batch query and retrieves data row by row.
emulateExecution() (opens new window)	Sets whether to emulate query execution, preventing any interaction with data storage.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exists()	Returns a value indicating whether the query result contains any row of data.
extraFields() (opens new window)	Returns the list of fields that can be expanded further and returned by toArray() (opens new window).
field()	Narrows the query results based on the field the Matrix blocks belong to.
fieldId()	Narrows the query results based on the field the Matrix blocks belong to, per the fields’ IDs.
fields() (opens new window)	Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified.
filterHaving() (opens new window)	Sets the HAVING part of the query but ignores empty operands (opens new window).
filterWhere() (opens new window)	Sets the WHERE part of the query but ignores empty operands (opens new window).
fixedOrder()	Causes the query results to be returned in the order specified by id().
from() (opens new window)	Sets the FROM part of the query.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
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() (opens new window)	Returns table names used in from() (opens new window) indexed by aliases.
groupBy() (opens new window)	Sets the GROUP BY part of the query.
hasDescendants()	Narrows the query results based on whether the {elements} have any descendants in their structure.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
having() (opens new window)	Sets the HAVING part of the query.
id()	Narrows the query results based on the {elements}’ IDs.
ids()	Executes the query and returns the IDs of the resulting elements.
ignorePlaceholders()	Causes the query to return matching {elements} as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement().
inReverse()	Causes the query results to be returned in reverse order.
indexBy() (opens new window)	Sets the indexBy() (opens new window) property.
init()	Initializes the object.
innerJoin() (opens new window)	Appends an INNER JOIN part to the query.
isJoined()	Returns whether a given table has been joined in this query.
join() (opens new window)	Appends a JOIN part to the query.
leaves()	Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants).
leftJoin() (opens new window)	Appends a LEFT OUTER JOIN part to the query.
level()	Narrows the query results based on the {elements}’ level within the structure.
limit() (opens new window)	Determines the number of {elements} that should be returned.
max() (opens new window)	Returns the maximum of the specified column values.
min() (opens new window)	Returns the minimum of the specified column values.
nextSiblingOf()	Narrows the query results to only the {element} that comes immediately after another {element} in its structure.
noCache() (opens new window)	Disables query cache for this Query.
nth()
off() (opens new window)	Detaches an existing event handler from this component.
offset() (opens new window)	Determines how many {elements} should be skipped in the results.
offsetExists()	Required by the ArrayAccess interface.
offsetGet()	Required by the ArrayAccess interface.
offsetSet()	Required by the ArrayAccess interface.
offsetUnset()	Required by the ArrayAccess interface.
on() (opens new window)	Attaches an event handler to an event.
one()
orFilterHaving() (opens new window)	Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window).
orFilterWhere() (opens new window)	Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window).
orHaving() (opens new window)	Adds an additional HAVING condition to the existing one.
orWhere() (opens new window)	Adds an additional WHERE condition to the existing one.
orderBy() (opens new window)	Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by}.)
owner()	Sets the ownerId() and siteId() parameters based on a given element.
ownerId()	Narrows the query results based on the owner element of the Matrix blocks, per the owners’ IDs.
pairs()	Executes the query and returns the first two columns in the results as key/value pairs.
params() (opens new window)	Sets the parameters to be bound to the query.
populate()	Converts the raw query results into the format as specified by this query.
positionedAfter()	Narrows the query results to only {elements} that are positioned after another {element} 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.
prepareSubquery()	Prepares the element query and returns its subquery (which determines what elements will be returned).
prevSiblingOf()	Narrows the query results to only the {element} that comes immediately before another {element} in its structure.
primaryOwner()	Sets the primaryOwnerId() and siteId() parameters based on a given element.
primaryOwnerId()	Narrows the query results based on the primary owner element of the Matrix blocks, per the owners’ IDs.
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() (opens new window)	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() (opens new window)	Sets the SELECT part of the query.
setCachedResult()	Sets the resulting elements.
siblingOf()	Narrows the query results to only {elements} that are siblings of another {element} 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() (opens new window)	Returns the sum of the specified column values.
title()	Narrows the query results based on the {elements}’ titles.
toArray() (opens new window)	Converts the model into an array.
trashed()	Narrows the query results to only {elements} that have been soft-deleted.
trigger() (opens new window)	Triggers an event.
type()	Narrows the query results based on the Matrix blocks’ block types.
typeId()	Narrows the query results based on the Matrix blocks’ block types, per the types’ IDs.
uid()	Narrows the query results based on the {elements}’ UIDs.
union() (opens new window)	Appends a SQL statement using UNION operator.
unique()	Determines whether only elements with unique IDs should be returned by the query.
uri()	Narrows the query results based on the {elements}’ URIs.
where() (opens new window)	Sets the WHERE part of the query.
with()	Causes the query to return matching {elements} eager-loaded with related elements.
withQuery() (opens new window)	Prepends a SQL statement using WITH syntax.
withStructure()	Explicitly determines whether the query should join in the structure data.

__set()

Sets the value of a component property.

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

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

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

View source (opens new window)

Arguments

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

Throws

• yii\base\UnknownPropertyException (opens new window)
  if the property is not defined
• yii\base\InvalidCallException (opens new window)
  if the property is read-only.

all()

View source (opens new window)

Arguments

• $db

Returns

craft\elements\MatrixBlock[], array (opens new window) –

allowOwnerDrafts()

Since

3.3.10

Narrows the query results based on whether the Matrix blocks’ owners are drafts.

Possible values include:

Value	Fetches Matrix blocks…
true	which can belong to a draft.
false	which cannot belong to a draft.

View source (opens new window)

Arguments

• $value (boolean (opens new window), null (opens new window)) – The property value

Returns

self – Self reference

allowOwnerRevisions()

Since

3.3.10

Narrows the query results based on whether the Matrix blocks’ owners are revisions.

Possible values include:

Value	Fetches Matrix blocks…
true	which can belong to a revision.
false	which cannot belong to a revision.

View source (opens new window)

Arguments

• $value (boolean (opens new window), null (opens new window)) – The property value

Returns

self – Self reference

field()

Since

3.4.0

Narrows the query results based on the field the Matrix blocks belong to.

Possible values include:

Value	Fetches {elements}…
'foo'	in a field with a handle of foo.
'not foo'	not in a field with a handle of foo.
['foo', 'bar']	in a field with a handle of foo or bar.
['not', 'foo', 'bar']	not in a field with a handle of foo or bar.
a craft\fields\Matrix object	in a field represented by the object.

View source (opens new window)

Arguments

• $value (mixed) – The property value

Returns

self – Self reference

Example

• Twig
• PHP

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

fieldId()

Narrows the query results based on the field the Matrix blocks belong to, per the fields’ IDs.

Possible values include:

Value	Fetches Matrix blocks…
1	in a field with an ID of 1.
'not 1'	not in a field with an ID of 1.
[1, 2]	in a field with an ID of 1 or 2.
['not', 1, 2]	not in a field with an ID of 1 or 2.

View source (opens new window)

Arguments

• $value (mixed) – The property value

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks in the field with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .fieldId(1)
  .all() %}

nth()

View source (opens new window)

Arguments

• $n
• $db = null

Returns

craft\elements\MatrixBlock, array (opens new window), null (opens new window) –

one()

View source (opens new window)

Arguments

• $db

Returns

craft\elements\MatrixBlock, array (opens new window), null (opens new window) –

owner()

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

View source (opens new window)

Arguments

• $owner (craft\base\ElementInterface) – The owner element

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks created for this entry #}
{% set {elements-var} = {twig-method}
  .owner(myEntry)
  .all() %}

ownerId()

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

Possible values include:

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

View source (opens new window)

Arguments

• $value (mixed) – The property value

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks created for an element with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .ownerId(1)
  .all() %}

primaryOwner()

Since

4.0.0

Sets the primaryOwnerId() and siteId() parameters based on a given element.

View source (opens new window)

Arguments

• $primaryOwner (craft\base\ElementInterface) – The primary owner element

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks created for this entry #}
{% set {elements-var} = {twig-method}
  .primaryOwner(myEntry)
  .all() %}

primaryOwnerId()

Since

4.0.0

Narrows the query results based on the primary owner element of the Matrix blocks, per the owners’ IDs.

Possible values include:

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

View source (opens new window)

Arguments

• $value (mixed) – The property value

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks created for an element with an ID of 1 #}
{% set {elements-var} = {twig-method}
  .primaryOwnerId(1)
  .all() %}

type()

Narrows the query results based on the Matrix blocks’ block types.

Possible values include:

Value	Fetches Matrix blocks…
'foo'	of a type with a handle of foo.
'not foo'	not of a type with a handle of foo.
['foo', 'bar']	of a type with a handle of foo or bar.
['not', 'foo', 'bar']	not of a type with a handle of foo or bar.
an MatrixBlockType object	of a type represented by the object.

View source (opens new window)

Arguments

• $value (mixed) – The property value

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks with a Foo block type #}
{% set {elements-var} = myEntry.myMatrixField
  .type('foo')
  .all() %}

typeId()

Narrows the query results based on the Matrix blocks’ block types, per the types’ IDs.

Possible values include:

Value	Fetches Matrix blocks…
1	of a type with an ID of 1.
'not 1'	not of a type with an ID of 1.
[1, 2]	of a type with an ID of 1 or 2.
['not', 1, 2]	not of a type with an ID of 1 or 2.

View source (opens new window)

Arguments

• $value (mixed) – The property value

Returns

self – Self reference

Example

• Twig
• PHP

{# Fetch Matrix blocks of the block type with an ID of 1 #}
{% set {elements-var} = myEntry.myMatrixField
  .typeId(1)
  .all() %}

Protected Methods

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

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.

View source (opens new window)

Returns

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

Throws

• yii\base\InvalidConfigException (opens new window)

cacheTags()

Since

3.5.0

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

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

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

View source (opens new window)

Returns

string (opens new window)[]

customFields()

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

View source (opens new window)

Returns

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