Playa Documentation

Installation & Updating

These instructions use the modern ExpressionEngine add-on directory layout and ExpressionEngine 7 control-panel labels. Use a Playa release compatible with your ExpressionEngine installation, and check the ExpressionEngine system requirements for your server.

Installing Playa

  1. Download and extract your Playa package.
  2. Copy the package's playa add-on folder into system/user/addons/, so that system/user/addons/playa/addon.setup.php exists.
  3. Copy the package's themes/playa folder into themes/user/, so that the scripts, styles, and images are available under themes/user/playa/.
  4. Open Add-Ons in the ExpressionEngine control panel, find Playa under Third Party Add-Ons, and click Install.
  5. Follow any license prompt shown for your installation, then create a Playa field.

If your site uses a renamed system directory or a custom themes location, use those configured locations instead. The add-on files belong in the system directory; browser-accessible scripts and styles belong in the themes directory.

ExpressionEngine's Add-On Manager documentation explains the installation controls and permissions.

Updating Playa

  1. Back up your site's database and files, and test the new release on a copy of the site before updating production.
  2. Read the Playa changelog for the release you are installing.
  3. Upload the new add-on files to system/user/addons/playa/ and the matching theme files to themes/user/playa/, replacing the previous release's files.
  4. Open Add-Ons. If Playa shows an Update action, run it to apply the release's update script. Do not uninstall Playa as an update step.
  5. Reload the control panel with a fresh browser cache so that the new Playa scripts and styles are loaded.
  6. Open an entry containing a Playa field and confirm that its saved selections load. Check the corresponding front-end template output before completing the update.

Checking the installation

  • Playa is missing from the field types: check that its add-on folder is in the correct site installation and that Playa is installed in Add-Ons.
  • The field has missing styling or controls: check that the matching theme files were uploaded and that the configured themes URL is accessible to your browser.
  • The field has no available entries: review the field's channel, status, date, and author filters in Working with Fields.

Next, read Playa Terminology and choose between the field tags and module tags for your templates.

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.