Param | Accepts | Description |
---|---|---|
addOrderBy |
`string | array |
addSelect |
`string | array |
ancestorDist |
`int | null` |
ancestorOf |
`int | ElementInterface |
andWhere |
`string | array` |
archived |
bool |
Whether to return only archived elements |
asArray |
bool |
Whether to return each element as an array |
contentTable |
`string | null` |
customFields |
`FieldInterface[] | null` |
dateCreated |
mixed |
When the resulting elements must have been created |
dateUpdated |
mixed |
When the resulting elements must have been last updated |
descendantDist |
`int | null` |
descendantOf |
`int | ElementInterface |
elementType |
`string | null` |
enabledForSite |
bool |
Whether the elements must be enabled for the chosen site |
fieldId |
`int | int[] |
fixedOrder |
bool |
Whether results should be returned in the order specified by id |
id |
`int | int[] |
indexBy |
`string | callable` |
level |
`int | null` |
limit |
integer |
Maximum number of records to be returned |
nextSiblingOf |
`int | ElementInterface |
offset |
integer |
Zero-based offset from where the records are to be returned |
orWhere |
`string | array` |
orderBy |
array |
How to sort the query results |
owner |
ElementInterface |
Sets the ownerId and ownerSiteId params based on a given element |
ownerId |
`int | int[] |
ownerLocale |
`string | string[]` |
ownerSite |
`string | string[] |
ownerSiteId |
`int | string |
positionedAfter |
`int | ElementInterface |
positionedBefore |
`int | ElementInterface |
prevSiblingOf |
`int | ElementInterface |
ref |
`string | string[] |
relatedTo |
`int | array |
search |
`string | array |
select |
array |
The columns being selected |
siblingOf |
`int | ElementInterface |
site |
`string | Site` |
siteId |
`int | null` |
slug |
`string | string[] |
status |
`string | string[] |
structureId |
`int | false |
title |
`string | string[] |
type |
`string | string[] |
typeId |
`int | int[] |
uid |
`string | string[] |
uri |
`string | string[] |
where |
`string | array` |
with |
`string | array |