Playa Documentation

Documentation


Product Details Changelog FAQs

Tags

These terms are used throughout the documentation:
required: This parameter/field is required for this tag to function.
form only: This can only be set as a field in the form and not as a parameter in the tag.
param only: This parameter can only be set in the tag and not as a field in the form.
fixed value: This field cannot be edited and is set with a fixed value.
recurring only: This parameter/field only applies to recurring charges.
one-time only: This parameter/field only applies to one-time charges.
added in X.X.X: This parameter/field is only available from this version forward.
logged in: This tag is only available if the user is logged in.
has the following front-end tags:
{exp:playa:children}
{exp:playa:children} supports almost all of the {exp:channel:entries} tag parameters, as well as the following:
{exp:playa:parents}
You can use the {exp:playa:parents} tag pair to loop through entries that relate a given entry(s).
{exp:playa:siblings}
You can use the {exp:playa:siblings} tag pair to loop through entries that share a common parent with other entries.
{exp:playa:coparent}
You can use the {exp:playa:coparents} tag pair to loop through entries that share a common child with other entries. Note: By default, co-parents will be ordered by the number of common children they share with the original entry. You can override that with the orderby param. Note: Playa sets the disable tag parameter to “categories|category_fields|member_data|pagination” by default. So if you want to display categories, member data, or pagination tags in your Playa tag pair, you’ll need to override that parameter.
{exp:playa:total_parents}
You can use the {exp:playa:total_parents} tag to get the total number of entries that relate a given entry(s). {exp:playa:total_parents} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
{exp:playa:total_children}
You can use the {exp:playa:total_children} tag to get the total number of entries related by Playa fields. {exp:playa:total_children} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
{exp:playa:total_siblings}
You can use the {exp:playa:total_siblings} tag to get the total number of entries that share a common parent with other entries. {exp:playa:total_siblings} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
{exp:playa:total_coparents}
You can use the {exp:playa:total_coparents} tag to get the total number of entries that share a common child with other entries. {exp:playa:total_coparents} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
{exp:playa:child_ids}
You can use the {exp:playa:child_ids} tag to get a list of the entry IDs related by Playa fields. {exp:playa:child_ids} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
{exp:playa:parent_ids}
{exp:playa:parent_ids} supports almost all of {exp:channel:entries} tag parameters, as well as the following:
{exp:playa:sibling_ids}
{exp:playa:sibling_ids} supports almost all of {exp:channel:entries} tag parameters, as well as the following:
{exp:playa:coparent_ids}
{exp:playa:children}
{exp:playa:children} supports almost all of the {exp:channel:entries} tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The parent entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:children entry_id="65"}
child_id
integer
The child entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:children child_id="44"}
field
string
The Playa field’s name where the relationship was made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:children field="name"}
field_id
integer
The Playa field’s ID where the relationship was made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:children field_id="90"}
col
The Matrix column’s name where the relationship was made.
{exp:playa:children col="columns title"}
col_id
integer
The Matrix column’s ID where the relationship was made.
{exp:playa:children col_id="78"}
row_id
The Matrix row’s ID where the relationship was made.
{exp:playa:children row_id="8"}
var
string
The Low Variables variable’s name where the relationship was made.
{exp:playa:children var="name"}
var_id
integer
The Low Variables variable’s ID where the relationship was made.
{exp:playa:children var_id="7"}
var_prefix
Tells Playa to only parse variables that have a certain prefix. This is handy when you’re dealing with variable name conflicts, such as if you’re pulling in an entry with its own Playa tag: Note: Playa sets the disable tag parameter to “categories|category_fields|member_data|pagination” by default. So if you want to display categories, member data, or pagination tags in your Playa tag pair, you’ll need to override that parameter.
{exp:playa:children var_prefix="top"}
Variables
children
supports almost all of {exp:channel:entries}’ `conditional variables , single variables, and variable pairs, as well as the following: {if no_children} … {/if} Outputs the contents only when there are no child entries returned.
{exp:playa:children}
{exp:playa:parents}
You can use the {exp:playa:parents} tag pair to loop through entries that relate a given entry(s).
Tag Parameters
entry_id
integer
The child entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:parents entry_id="44"}
parent_id
The parent entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:parents parent_id="88"}
field
string
The Playa field’s name where the relationship was made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:parents field="name"}
field_id
integer
The Playa field’s ID where the relationship was made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:parents field_id="44"}
col
The Matrix column’s name where the relationship was made.
{exp:playa:parents col="col name"}
col_id
The Matrix column’s ID where the relationship was made.
{exp:playa:parents col_id="6"}
row_id
integer
The Matrix row’s ID where the relationship was made.
{exp:playa:parents row_id="8"}
var_prefix
string
Tells Playa to only parse variables that have a certain prefix. This is handy when you’re dealing with variable name conflicts, such as if you’re pulling in an entry with its own Playa tag.
{exp:playa:parents var_prefix="var"}
Variables
parents
supports almost all of {exp:channel:entries}’ conditional variables,single variables, and `variable pairs, as well as the following: {if no_parents} … {/if} Outputs the contents only when there are no parent entries returned.
{exp:playa:parents}
{exp:playa:siblings}
You can use the {exp:playa:siblings} tag pair to loop through entries that share a common parent with other entries.
Tag Parameters
entry_id
integer
The main entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:siblings entry_id="6"}
sibling_id
The sibling entry ID(s) to include. Prefix with “not ” to define entries to exclude instead.
{exp:playa:siblings sibling_id="42"}
parent_id
The parent entry ID(s) that the siblings must have in common. Prefix with “not ” to define entries to exclude instead.
{exp:playa:siblings parent_id="7"}
field
The Playa field’s name where the relationships were made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:siblings field="name"}
field_id
integer
The Playa field’s ID where the relationships were made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:siblings field_id="89"}
col
string
The Matrix column’s name where the relationships were made.
{exp:playa:siblings col="column name"}
col_id
integer
The Matrix column’s ID where the relationships were made.
{exp:playa:siblings col_id="88"}
row_id
integer
The Matrix row’s ID where the relationships were made.
{exp:playa:siblings row_id="55"}
var_prefix
string
Tells Playa to only parse variables that have a certain prefix. This is handy when you’re dealing with variable name conflicts, such as if you’re pulling in an entry with its own Playa tag.
{exp:playa:siblings var_prefix="pre"}
Variables
this
supports almost all of {exp:channel:entries}’ conditional variables,single variables, and `variable pairs, as well as the following: {if no_siblings} … {/if} Outputs the contents only when there are no sibling entries returned.
{exp:playa:siblings}
{exp:playa:coparent}
You can use the {exp:playa:coparents} tag pair to loop through entries that share a common child with other entries. Note: By default, co-parents will be ordered by the number of common children they share with the original entry. You can override that with the orderby param. Note: Playa sets the disable tag parameter to “categories|category_fields|member_data|pagination” by default. So if you want to display categories, member data, or pagination tags in your Playa tag pair, you’ll need to override that parameter.
Tag Parameters
entry_id
integer
The main entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:siblings entry_id="6"}
coparent_id
integer
The co-parent entry ID(s) to include. Prefix with “not ” to define entries to exclude instead.
{exp:playa:coparent coparent_id="78"}
child_id
integer
The child entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:children child_id="44"}
field
string
The Playa field’s name where the relationship was made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:children field="name"}
field_id
integer
The Playa field’s ID where the relationship was made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:children field_id="90"}
col
The Matrix column’s name where the relationship was made.
{exp:playa:children col="columns title"}
col_id
integer
The Matrix column’s ID where the relationship was made.
{exp:playa:children col_id="78"}
row_id
The Matrix row’s ID where the relationship was made.
{exp:playa:children row_id="8"}
var_prefix
Tells Playa to only parse variables that have a certain prefix. This is handy when you’re dealing with variable name conflicts, such as if you’re pulling in an entry with its own Playa tag: Note: Playa sets the disable tag parameter to “categories|category_fields|member_data|pagination” by default. So if you want to display categories, member data, or pagination tags in your Playa tag pair, you’ll need to override that parameter.
{exp:playa:children var_prefix="top"}
Variables
this
supports almost all of {exp:channel:entries}’ conditional variables,single variables, and `variable pairs, as well as the following: {if no_coparents} … {/if} Outputs the contents only when there are no coparents entries returned.
{exp:playa:coparents}
{exp:playa:total_parents}
You can use the {exp:playa:total_parents} tag to get the total number of entries that relate a given entry(s). {exp:playa:total_parents} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The child entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:total_parents entry_id="65"}
parent_id
integer
The parent entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:total_parent parent_id="44"}
field
string
The Playa field’s name where the relationship was made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:total_parents field="name"}
field_id
integer
The Playa field’s ID where the relationship was made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:total_parents field_id="90"}
col
The Matrix column’s name where the relationship was made.
{exp:playa:total_parents col="columns title"}
col_id
integer
The Matrix column’s ID where the relationship was made.
{exp:playa:total_parents col_id="78"}
row_id
The Matrix row’s ID where the relationship was made.
{exp:playa:total_parents row_id="8"}
{exp:playa:total_children}
You can use the {exp:playa:total_children} tag to get the total number of entries related by Playa fields. {exp:playa:total_children} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The parent entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:total_children entry_id="65"}
child_id
integer
The child entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:total_children child_id="44"}
field
string
The Playa field’s name where the relationship was made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:total_children field="name"}
field_id
integer
The Playa field’s ID where the relationship was made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:total_children field_id="90"}
col
The Matrix column’s name where the relationship was made.
{exp:playa:total_children col="columns title"}
col_id
integer
The Matrix column’s ID where the relationship was made.
{exp:playa:total_children col_id="78"}
row_id
The Matrix row’s ID where the relationship was made.
{exp:playa:total_children row_id="8"}
var
string
The Low Variables variable’s name where the relationship was made.
{exp:playa:total_children var="name"}
var_id
integer
The Low Variables variable’s ID where the relationship was made.
{exp:playa:total_children var_id="7"}
{exp:playa:total_siblings}
You can use the {exp:playa:total_siblings} tag to get the total number of entries that share a common parent with other entries. {exp:playa:total_siblings} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The parent entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:total_siblings entry_id="65"}
sibling_id
integer
The sibling entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:total_siblings sibling_id="44"}
field
string
The Playa field’s name where the relationship was made, or the Matrix field’s name if your Playa field lives within a Matrix field.
{exp:playa:total_siblings field="name"}
field_id
integer
The Playa field’s ID where the relationship was made, or the Matrix field’s ID if your Playa field lives within a Matrix field.
{exp:playa:total_siblings field_id="90"}
col
The Matrix column’s name where the relationship was made.
{exp:playa:total_siblings col="columns title"}
col_id
integer
The Matrix column’s ID where the relationship was made.
{exp:playa:total_siblings col_id="78"}
row_id
The Matrix row’s ID where the relationship was made.
{exp:playa:total_siblings row_id="8"}
{exp:playa:total_coparents}
You can use the {exp:playa:total_coparents} tag to get the total number of entries that share a common child with other entries. {exp:playa:total_coparents} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The main entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:total_coparents entry_id="7"}
coparent_id
The co-parent entry ID(s) to include. Prefix with “not ” to define entries to exclude instead.
{exp:playa:total_coparents coparent_id="7"}
child_id
The child entry ID(s) that the co-parents must have in common. Prefix with “not ” to define entries to exclude instead.
{exp:playa:total_coparents child_id="89"}
field
string
The Playa fields name where the relationship was made, or the Matrix fields name if your Playa field lives within a Matrix field.
{exp:playa:children field="name"}
field_id
integer
The Playa fields ID where the relationship was made, or the Matrix fields ID if your Playa field lives within a Matrix field.
{exp:playa:children field_id="90"}
col
The Matrix columns name where the relationship was made.
{exp:playa:children col="columns title"}
col_id
integer
The Matrix columns ID where the relationship was made.
{exp:playa:children col_id="78"}
row_id
The Matrix rows ID where the relationship was made.
{exp:playa:children row_id="8"}
{exp:playa:child_ids}
You can use the {exp:playa:child_ids} tag to get a list of the entry IDs related by Playa fields. {exp:playa:child_ids} supports almost all of {exp:channel:entries}’ tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The parent entrys ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:child_ids entry_id="65"}
child_id
integer
The child entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:child_ids child_id="44"}
field
string
The Playa fields name where the relationship was made, or the Matrix fields name if your Playa field lives within a Matrix field.
{exp:playa:child_ids field="name"}
field_id
integer
The Playa fields ID where the relationship was made, or the Matrix fields ID if your Playa field lives within a Matrix field.
{exp:playa:child_ids field_id="90"}
col
The Matrix columns name where the relationship was made.
{exp:playa:child_ids col="columns title"}
col_id
integer
The Matrix columns ID where the relationship was made.
{exp:playa:child_ids col_id="78"}
row_id
The Matrix rows ID where the relationship was made.
{exp:playa:child_ids row_id="8"}
var
string
The Low Variables variables name where the relationship was made.
{exp:playa:child_ids var="name"}
var_id
integer
The Low Variables variables ID where the relationship was made.
{exp:playa:child_ids var_id="7"}
delimiter
integer
The string used to separate the returned entry IDs. (The default is “|”.)
accepts: string
{exp:playa:child_ids delimiter="-"}
{exp:playa:parent_ids}
{exp:playa:parent_ids} supports almost all of {exp:channel:entries} tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The child entrys ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:parent_ids entry_id="65"}
parent_id
integer
The parent entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:parent_ids child_id="44"}
field
string
The Playa fields name where the relationship was made, or the Matrix fields name if your Playa field lives within a Matrix field.
{exp:playa:parent_ids field="name"}
field_id
integer
The Playa fields ID where the relationship was made, or the Matrix fields ID if your Playa field lives within a Matrix field.
{exp:playa:parent_ids field_id="90"}
col
The Matrix columns name where the relationship was made.
{exp:playa:parent_ids col="columns title"}
col_id
integer
The Matrix columns ID where the relationship was made.
{exp:playa:parent_ids col_id="78"}
row_id
The Matrix rows ID where the relationship was made.
{exp:playa:parent_ids row_id="8"}
delimiter
string
The string used to separate the returned entry IDs. (The default is “|”.)
{exp:playa:parent_ids delimiter="-"}
{exp:playa:sibling_ids}
{exp:playa:sibling_ids} supports almost all of {exp:channel:entries} tag parameters, as well as the following:
Tag Parameters
entry_id
integer
The child entrys ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:sibling_ids entry_id="65"}
sibling_id
integer
The sibling entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:sibling_ids sibling_id="44"}
field
string
The Playa fields name where the relationship was made, or the Matrix fields name if your Playa field lives within a Matrix field.
{exp:playa:sibling_ids field="name"}
field_id
integer
The Playa fields ID where the relationship was made, or the Matrix fields ID if your Playa field lives within a Matrix field.
{exp:playa:sibling_ids field_id="90"}
col
The Matrix columns name where the relationship was made.
{exp:playa:sibling_ids col="columns title"}
col_id
integer
The Matrix columns ID where the relationship was made.
{exp:playa:sibling_ids col_id="78"}
row_id
The Matrix rows ID where the relationship was made.
{exp:playa:sibling_ids row_id="8"}
delimiter
string
The string used to separate the returned entry IDs. (The default is “|”.)
{exp:playa:sibling_ids delimiter="-"}
{exp:playa:coparent_ids}
Tag Parameters
entry_id
integer
The parent entry’s ID(s). If your tag is within an {exp:channel:entries} tag pair, this will default to the current entry’s ID.
{exp:playa:children entry_id="65"}
child_id
integer
The child entry ID(s) to include. Prefix with “not” to define entries to exclude instead.
{exp:playa:children child_id="44"}
coparent_id
integer
The co-parent entry ID(s) to include. Prefix with “not ” to define entries to exclude instead.
{exp:playa:coparent coparent_id="78"}
field
string
The Playa fields name where the relationship was made, or the Matrix fields name if your Playa field lives within a Matrix field.
{exp:playa:child_ids field="name"}
field_id
integer
The Playa fields ID where the relationship was made, or the Matrix fields ID if your Playa field lives within a Matrix field.
{exp:playa:child_ids field_id="90"}
col
The Matrix columns name where the relationship was made.
{exp:playa:child_ids col="columns title"}
col_id
integer
The Matrix columns ID where the relationship was made.
{exp:playa:child_ids col_id="78"}
row_id
The Matrix rows ID where the relationship was made.
{exp:playa:child_ids row_id="8"}
delimiter
string
The string used to separate the returned entry IDs. (The default is “|”.)
{exp:playa:child_ids delimiter="-"}

Support

Having problems setting up and/or using Playa? Support is offered from 10am to 4pm EST weekdays. Send us an email at help@eeharbor.com and we will respond as quickly as we can.

loading