PurchasedTicket Queries

You can fetch purchased tickets in your templates or PHP code using purchased ticket queries.

{# Create a new purchased ticket query #}
{% set myQuery = craft.events.purchasedTickets() %}
// Create a new purchased ticket query
$myQuery = \verbb\events\elements\PurchasedTicket::find();

Once you’ve created a purchased tickets query, you can set parameters on it to narrow down the results, and then execute it by calling .all(). An array of PurchasedTicket objects will be returned.

See Introduction to Element Queries in the Craft docs to learn about how element queries work.

Example #

We can display purchased tickets for a given event by doing the following:

  1. Create an purchased ticket query with craft.events.purchasedTickets().
  2. Set the eventId and limit parameters on it.
  3. Fetch all purchased tickets with .all() and output.
  4. Loop through the purchased tickets using a for tag to output the contents.
{# Create a purchased tickets query with the 'type' and 'limit' parameters #}
{% set purchasedTicketsQuery = craft.events.purchasedTickets()
    .eventId(123)
    .limit(10) %}

{# Fetch the PurchasedTickets #}
{% set purchasedTickets = purchasedTicketsQuery.all() %}

{# Display their contents #}
{% for purchasedTicket in purchasedTickets %}
    <p>{{ purchasedTicket.title }}</p>
{% endfor %}

Parameters #

Purchased Ticket queries support the following parameters:

asArray #

Causes the query to return matching purchased tickets as arrays of data, rather than PurchasedTicket objects.

{# Fetch purchased tickets as arrays #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .asArray()
    .all() %}
// Fetch purchased tickets as arrays
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->asArray()
    ->all();

customer #

Narrows the query results to only purchased tickets that have been purchased by a customer.

{# Fetch purchased tickets that have been purchased by a customer #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .customer(craft.commerce.getCart().customer)
    .all() %}
// Fetch purchased tickets that have been purchased by a customer
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->customer($customer)
    ->all();

dateCreated #

Narrows the query results based on the purchased tickets creation dates.

Possible values include:

ValueFetches purchased tickets…
'>= 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.
{# Fetch purchased tickets created last month #}
{% set start = date('first day of last month') | atom %}
{% set end = date('first day of this month') | atom %}

{% set purchasedTickets = craft.events.purchasedTickets()
    .dateCreated(['and', ">= #{start}", "< #{end}"])
    .all() %}
// Fetch purchased tickets created last month
$start = new \DateTime('first day of next month')->format(\DateTime::ATOM);
$end = new \DateTime('first day of this month')->format(\DateTime::ATOM);

$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->dateCreated(['and', ">= {$start}", "< {$end}"])
    ->all();

dateUpdated #

Narrows the query results based on the purchased tickets last-updated dates.

Possible values include:

ValueFetches purchased tickets…
'>= 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.
{# Fetch purchased tickets updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}

{% set purchasedTickets = craft.events.purchasedTickets()
    .dateUpdated(">= #{lastWeek}")
    .all() %}
// Fetch purchased tickets updated in the last week
$lastWeek = new \DateTime('1 week ago')->format(\DateTime::ATOM);

$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->dateUpdated(">= {$lastWeek}")
    ->all();

eventId #

Narrows the query results based on the purchased tickets event ID.

Possible values include:

ValueFetches purchased tickets…
1for a event with an ID of 1.
[1, 2]for event with an ID of 1 or 2.
['not', 1, 2]for event not with an ID of 1 or 2.
{# Fetch purchased tickets for an event #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .eventId(123)
    .all() %}
// Fetch purchased tickets for an event
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->eventId(123)
    ->all();

fixedOrder #

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

{# Fetch purchased tickets in a specific order #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .id([1, 2, 3, 4, 5])
    .fixedOrder()
    .all() %}
// Fetch purchased tickets in a specific order
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->id([1, 2, 3, 4, 5])
    ->fixedOrder()
    ->all();

id #

Narrows the query results based on the purchased tickets IDs.

Possible values include:

ValueFetches purchased tickets…
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.
{# Fetch the purchased ticket by its ID #}
{% set purchasedTicket = craft.events.purchasedTickets()
    .id(1)
    .one() %}
// Fetch the purchased ticket by its ID
$purchasedTicket = \verbb\events\elements\PurchasedTicket::find()
    ->id(1)
    ->one();

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

inReverse #

Causes the query results to be returned in reverse order.

{# Fetch purchased tickets in reverse #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .inReverse()
    .all() %}
// Fetch purchased tickets in reverse
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->inReverse()
    ->all();

limit #

Determines the number of purchased tickets that should be returned.

{# Fetch up to 10 purchased tickets #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .limit(10)
    .all() %}
// Fetch up to 10 purchased tickets
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->limit(10)
    ->all();

lineItemId #

Narrows the query results based on the purchased tickets Commerce line item ID.

Possible values include:

ValueFetches purchased tickets…
1for a Commerce line item with an ID of 1.
[1, 2]for Commerce line item with an ID of 1 or 2.
['not', 1, 2]for Commerce line item not with an ID of 1 or 2.
{# Fetch purchased tickets for a Commerce line item #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .lineItemId(123)
    .all() %}
// Fetch purchased tickets for a Commerce line item
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->lineItemId(123)
    ->all();

offset #

Determines how many purchased tickets should be skipped in the results.

{# Fetch all purchased tickets except for the first 3 #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .offset(3)
    .all() %}
// Fetch all purchased tickets except for the first 3
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->offset(3)
    ->all();

orderId #

Narrows the query results based on the purchased tickets Commerce order ID.

Possible values include:

ValueFetches purchased tickets…
1for a Commerce order with an ID of 1.
[1, 2]for Commerce order with an ID of 1 or 2.
['not', 1, 2]for Commerce order not with an ID of 1 or 2.
{# Fetch purchased tickets for a Commerce order #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .orderId(123)
    .all() %}
// Fetch purchased tickets for a Commerce order
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->orderId(123)
    ->all();

orderBy #

Determines the order that the purchased tickets should be returned in.

{# Fetch all purchased tickets in order of date created #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .orderBy('elements.dateCreated asc')
    .all() %}
// Fetch all purchased tickets in order of date created
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->orderBy('elements.dateCreated asc')
    ->all();

relatedTo #

Narrows the query results to only purchased tickets that are related to certain other elements.

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

{# Fetch all purchased tickets that are related to myCategory #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .relatedTo(myCategory)
    .all() %}
// Fetch all purchased tickets that are related to $myCategory
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->relatedTo($myCategory)
    ->all();

ticketId #

Narrows the query results based on the purchased tickets ticket ID.

Possible values include:

ValueFetches purchased tickets…
1for a ticket with an ID of 1.
[1, 2]for ticket with an ID of 1 or 2.
['not', 1, 2]for ticket not with an ID of 1 or 2.
{# Fetch purchased tickets for a ticket #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .ticketId(123)
    .all() %}
// Fetch purchased tickets for a ticket
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->ticketId(123)
    ->all();

search #

Narrows the query results to only purchased tickets that match a search query.

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

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

{# Fetch all purchased tickets that match the search query #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .search(searchQuery)
    .all() %}
// Get the search query from the 'q' query string param
$searchQuery = \Craft::$app->request->getQueryParam('q');

// Fetch all purchased tickets that match the search query
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->search($searchQuery)
    ->all();

site #

Determines which site the purchased tickets should be queried in.

The current site will be used by default.

Possible values include:

ValueFetches purchased tickets…
'foo'from the site with a handle of foo.
a \craft\commerce\elements\db\Site objectfrom the site represented by the object.
{# Fetch purchased tickets from the Foo site #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .site('foo')
    .all() %}
// Fetch purchased tickets from the Foo site
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->site('foo')
    ->all();

siteId #

Determines which site the purchased tickets should be queried in, per the site’s ID.

The current site will be used by default.

{# Fetch purchased tickets from the site with an ID of 1 #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .siteId(1)
    .all() %}
// Fetch purchased tickets from the site with an ID of 1
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->siteId(1)
    ->all();

uid #

Narrows the query results based on the purchased tickets UIDs.

{# Fetch the purchased ticket by its UID #}
{% set purchasedTicket = craft.events.purchasedTickets()
    .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    .one() %}
// Fetch the purchased ticket by its UID
$purchasedTicket = \verbb\events\elements\PurchasedTicket::find()
    ->uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    ->one();

with #

Causes the query to return matching purchased tickets eager-loaded with related elements.

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

{# Fetch purchased tickets eager-loaded with the "Related" field’s relations #}
{% set purchasedTickets = craft.events.purchasedTickets()
    .with(['related'])
    .all() %}
// Fetch purchased tickets eager-loaded with the "Related" field’s relations
$purchasedTickets = \verbb\events\elements\PurchasedTicket::find()
    ->with(['related'])
    ->all();

Get started with Events

Available for Craft 3. Get it from the plugin store.