Hype5 Theater 0.6.17 · Pre-release

User roles and permissions

Hype5 Theater uses WordPress roles and capabilities. It adds one role, Theater Manager, and gives the same permissions to administrators. Every screen and save — classic or in the Hype5 app — checks the same capabilities.

On this page

Roles at a glance

Role Can do in Hype5 Theater
Administrator Everything: content, credits, performances, venues, vocabularies, settings, Appearance, and custom CSS (where WordPress allows unfiltered HTML).
Theater Manager (Teatri haldur) All Hype5 content and plugin settings: productions, people, venues, credits, performances, vocabulary terms, Settings, Add-ons and System Status; can upload media. Not Appearance and the content-type option lists, which need manage_options.
Editor, Author, Contributor, Subscriber Nothing in Hype5 Theater by default.

To give an Editor or another role Hype5 permissions, add the capabilities you want with a role-management plugin or a few lines of code. The full list is in Roles and capabilities.

What each permission allows

You want someone to… They need
Edit productions edit_hype5t_productions (and the related others, published, private capabilities, as for WordPress posts)
Publish, schedule, make private or password-protect productions publish_hype5t_productions
Change credits (Meeskond) manage_hype5t_credits and permission to edit the production. Without it, credits are read-only.
Manage the schedule and ticket offers manage_hype5t_performances
Edit people or venues edit_hype5t_persons / edit_hype5t_venues
Add, edit, pause or delete genres, audience recommendations, warnings and professions manage_hype5t_settings
Change plugin settings, see Add-ons and System Status manage_hype5t_settings
Change Appearance and the content-type option lists manage_options (normally administrators only)
Change custom CSS edit_css — in WordPress this follows unfiltered HTML: unavailable when DISALLOW_UNFILTERED_HTML is set, and on multisite only for super admins
Add images and files, tag people in gallery images upload_files (tagging also needs read access to the person)

People who may edit but not publish can submit a production for review; they cannot publish, schedule, make private, set a password or change the publication time.

Hype5 app access

The Hype5 app is where Hype5 Theater is managed. A user can open it when both are true:

  1. the app is enabled for them by a site administrator (its access list, or for everyone with a constant — a capability-only rollout is still pending), and
  2. they have at least one of: edit productions, edit people, manage performances, edit venues.

For these users Hype5 Theater in the WordPress sidebar is one entry that opens the app. Everyone else with a Hype5 permission — including users whose only permission is Settings or Vocabularies — keeps the classic Hype5 Theater menu, each item under its own permission.

Enabling the app never grants a permission. Inside the app each screen follows the same capabilities as the classic screens, and a destination a user may not use is shown as a link to the classic screen or not at all. See The Hype5 app.

Records you may not read

Lists and usage counts never name records a user may not read; at most they are counted. For example, a venue's usage list leaves out performances of productions the user cannot read, but includes them in the count.

When the role is created

The capabilities are added on activation and again whenever the plugin version changes (on the next admin page load by a user with manage_options). Deactivating or removing the plugin does not remove the role or the capabilities.