Playa Documentation

Playa Terminology

Playa relationships have a direction: an entry selects another entry through a Playa field. The entry making the selection is the parent, and the selected entry is the child. These terms describe each relationship; an entry can be a parent in one relationship and a child in another.

Parent: The entry whose Playa field contains the selection.
Child: An entry selected in a parent's Playa field.
Sibling: Another entry that shares at least one parent with the current entry. The current entry is excluded from its own siblings.
Co-parent: Another entry that shares at least one child with the current entry. The current entry is excluded from its own co-parents.

Example: articles and photos

Suppose each article has a Playa field named article_photos:

  • Article A selects Photo One and Photo Two.
  • Article B selects Photo One.
Starting entry Relationship Result
Article A Children Photo One and Photo Two
Photo One Parents Article A and Article B
Photo One Siblings Photo Two, because Article A selects both photos
Article A Co-parents Article B, because both articles select Photo One

You do not need a second Playa field on a photo to find its parents. Playa's module tags can follow the existing relationship in either direction.

Choosing a tag

Use field tags inside a Channel Entries loop when you want the selections from a particular Playa field. Use the module tags when you need parents, siblings, co-parents, or relationship filters. An entry_id parameter identifies the starting entry; inside a Channel Entries loop, it defaults to that loop's current entry.

For setup instructions, see Working with Fields. For front-end editing, see Channel Form.

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.