Hype5 Theater 0.7.0 · Beta — by invitation

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. Since Theater 0.7.0 everyone with a Hype5 Theater administration permission opens it: edit productions, edit people, edit venues, manage performances, manage the Hype5 settings, change the Hype5 appearance (manage_options) or manage a vocabulary — the same people who saw the classic Hype5 Theater menu before. There is nothing to switch on.

For these users Hype5 Theater in the WordPress sidebar is one entry that opens the app. Users without such a permission (WordPress editors, authors and subscribers by default) see no Hype5 entry. A user whose only Hype5 permission is changing credits (manage_hype5t_credits) has no Hype5 screen at all: credits are edited inside a production, which also needs permission to edit productions.

Opening 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; a user who may only change settings, for example, sees Settings and Vocabularies. A site can switch the app off for everyone (the classic menu then returns); 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 Theater Manager role is created, and the capabilities are given to it and to Administrator, when the plugin installs its capabilities on a site for the first time (on activation).

  • Updates (any change of the plugin version, applied on the next admin page load by a user with manage_options) add only capabilities that are new in that version (Theater 0.7.0; the plugin records what it has granted in the hype5t_caps_granted option). A capability you removed from Administrator or Theater Manager is not given back, and a capability explicitly denied on the role is never overwritten.
  • A role you deleted stays deleted, also when the plugin is deactivated and activated again. To get it back, add it with code, or delete the hype5t_caps_version and hype5t_caps_granted options before activating, which grants the full set again.
  • Deactivating or removing the plugin does not remove the role or the capabilities.

Rolling back to 0.6.x gives capabilities back. Until 0.6.17 every version change re-added the full set. If you install a 0.6.x version over 0.7.0, it gives the full Hype5 capability set back to Administrator and Theater Manager — including capabilities you removed or denied — and recreates a Theater Manager role you deleted, on the next admin page. Check the roles after such a rollback; a later update to 0.7.0 keeps them as they then are. See Rolling back.