Introduction to Hype5

Hype5 is a family of WordPress products for theatres and performing-arts companies. It currently consists of a plugin, Hype5 Theater, and a theme, Hype5 Stage.

On this page

The products

Product What it is Documented version
Hype5 Theater A WordPress plugin that stores a theatre's productions, people, credits, venues and performances and presents them on the theatre's own website through shortcodes, blocks and overridable templates. 0.7.0 (Beta — by invitation)
Hype5 Stage A WordPress theme for theatres. It is a complete theme on its own and presents Hype5 Theater content in its own design when the plugin is active. 1.0.2 (Pre-release)

The two products are independent. Hype5 Theater is designed to work with any classic or block theme (see Compatibility for the themes tested), and Hype5 Stage works on sites without the plugin. Used together, Stage adds a theatre home page and restyles the plugin's public pages through the plugin's documented template and presentation contracts. See Product overview for help choosing.

Pre-release

Neither product is generally available yet. Hype5 Theater 0.7.0 is the approved release candidate, distributed as a beta by invitation: its ZIP is given to invited sites and installed by upload. It has not been published — there is no public download and the update service does not offer it. Hype5 Stage 1.0.2 is in pre-release testing. These pages describe the versions named above. Interfaces marked Provisional or Internal may change before release.

Principles shared by Hype5 products

  • Your content stays in WordPress. Productions, people and venues are WordPress posts; performances, credits and ticket offers are stored in the plugin's own database tables. Deactivating or removing the plugin keeps all data. See Data model.
  • Hype5 does not sell tickets. Ticket offers are links to the external sellers you already use. See Ticket offers.
  • Publishing follows WordPress. Publication status, visibility and passwords are WordPress's own settings. Unpublished and password-protected content is kept out of public lists. See Security and content visibility.
  • Works with your theme and tools. Shortcodes work in the Classic Editor, in block content and in page builders that render shortcodes; two blocks are available for the block editor. See Public display and themes, and Compatibility for what was tested.
  • English and Estonian. The administration is written in English and includes a complete Estonian translation. Public texts can be changed per language. See Translation and localisation.

How this documentation is organised

Area For Contents
Getting started Site owners and administrators Requirements, installation, first-time configuration, compatibility and updates.
Hype5 Theater Theatre staff who enter and publish content Task-based guides: productions, people and credits, the schedule, venues, appearance, vocabularies and settings.
Hype5 Stage Site owners and designers Installing and configuring the theme, the home page, navigation and the Theater integration.
Developer reference Developers and theme authors Shortcodes, blocks, REST routes, hooks, templates, presentation services, extension rules and the data model.
Reference and help Everyone Frequently asked questions, troubleshooting, glossary, compatibility, known limitations and changelogs.

The Hype5 app — the administration of Hype5 Theater — shows Estonian labels for Estonian users. Where it helps, the Estonian term is given in parentheses, for example Credits (Meeskond). The glossary lists both.

Offline manual

An offline copy of this documentation is available for each product. It opens from documentation/index.html in a web browser, needs no internet connection and includes search. See Offline manuals.