Hype5 Theater 0.7.0 · Beta — by invitation

Shortcodes

On this page

Shortcodes are the primary way to place Hype5 content in pages, posts, page builders and themes; they work without the block editor. There are three collection shortcodes (productions, people, schedule), modular production shortcodes and modular person shortcodes. All of them render through the same templates as the plugin's own pages and apply the plugin's public visibility rules.

Common rules

  • Attributes affect only that shortcode instance; no shortcode saves anything.
  • Presentation follows: shortcode attribute → the production's or person's own Display value → global Appearance → layout defaults → built-in default. Every display option can be given as an attribute.
  • Invalid attribute values fall back to defaults; invalid schedule filters produce an empty list rather than a broader one.
  • The plugin's stylesheets load automatically when a shortcode renders.

Collections

Collections read filter values from the URL (?hype5_genre=drama, see Queries). An attribute always wins over the URL, and a filter set by attribute is not shown in the filter bar. Several collections on one page share the same URL parameters; set filters="0" and explicit attributes for an independent list.

[hype5_productions]

Attribute Values Default
context current (playing, on hold or no repertory status), upcoming (coming soon), archive / archived, active (current and upcoming), all current (or hype5_context from the URL)
order auto, next (next performance), title, manual (WordPress menu order), premiere_asc, premiere_desc Appearance; auto = premiere_desc for the archive, premiere_asc for upcoming, otherwise next
genre, audience term slug —
language exact stored language text —
city exact city of a venue where the production has performances —
search WordPress search text —
layout cards, editorial, compact, list (and add-on layouts) Appearance; the archive uses the Appearance archive layout (list)
per_page (alias limit) 1–100 Appearance (12)
filters, pagination 1 / 0 1
page page number from the URL

Only published productions are listed. A password-protected production appears as a card with title, address, poster, genres, audience recommendation and premiere only.

Legacy names: [hype5_theater_productions] and [theater_productions] behave like [hype5_productions] with status="active"; status accepts the same values as context.

[hype5_people]

Attribute Values Default
profession profession slug —
company_status current, former, guest, none (no value counts as none) —
search WordPress search text —
layout grid, list, alphabetical Appearance (grid)
people_order sort_name, title Appearance (sort_name)
per_page (alias limit), filters, pagination, page as above

Only published people whose profile page is allowed and who are shown in the directory are listed.

[hype5_schedule]

Aliases: [hype5_next_performances], [hype5_theater_schedule], [theater_schedule].

Attribute Values Default
limit (alias per_page) 1–100 10
production, venue post ID (a translation's ID is mapped to the original) all
city exact venue city —
status scheduled, sold_out, cancelled, postponed all
access a service key (captioned, audio_described, signed, relaxed, sensory_friendly, interpretation) or an accessibility feature key —
from, to YYYY-MM-DD, inclusive, site time zone —
date_from, date_to as from/to; take precedence over them (also from the URL) —
month YYYY-MM; replaces from/to —
range today, week (site's first day of the week), month; takes precedence over dates —
past 1: only past performances 0
include_past 1: past and future 0
offset number of rows to skip 0
layout agenda, compact, cards, table Appearance general schedule layout
group_by month, city, none Appearance general schedule grouping
price_mode from_lowest, range, hide Appearance general schedule prices
filters, pagination 1 / 0 1

Without dates the schedule lists future performances, earliest first. An explicit date window also includes earlier performances inside it. Without production, only performances of productions that are public to everyone (published without a password, in the original and the reader's language) are listed; with production, a password-protected production's performances appear after its password has been entered only on the production's own page or when the page's address filters to it (?hype5_production=); on any other page only productions public to everyone are listed. Venues are named only when published. Past, cancelled, postponed and sold-out performances never show a purchase link.

Production shortcodes

Shortcode Output
[hype5_production] The full production page composition: hero and sections.
[hype5_production_title] Title.
[hype5_production_teaser] Short introduction.
[hype5_production_meta] Facts: premiere, duration, language, audience, premiere venue.
[hype5_production_image] Poster (featured image).
[hype5_production_content] Production text.
[hype5_production_cast] Credits by group.
[hype5_production_schedule] The production's performances.
[hype5_production_gallery] Gallery.
[hype5_production_media] (also [hype5_production_materials]) Videos, audio, external galleries, programme and files.
[hype5_production_important_info] Audience recommendations, language and warnings.
[hype5_production_warnings] Warnings.
[hype5_production_accessibility] Accessibility features and text.
[hype5_production_visitor] Visitor information.
[hype5_production_partners] Partners.
[hype5_production_articles] Articles and reviews.
[hype5_production_review_quote] The first article with a featured quote.
[hype5_production_links] Other links and the ELAB link.

Attributes:

  • id — production ID. Default: the production being viewed.
  • layout — the component's layout: production page (editorial, poster, wide, cinematic), cast (inline, list, table, grid), gallery (grid, masonry, carousel, feature), schedule (agenda, compact, cards, table), meta (inline, stacked), visitor (cards, list), media (featured, grid, list), partners (logos, list, compact), articles (list, cards, compact).
  • images — alias of cast_images (none, small, large).
  • group_by — alias of schedule_group.
  • [hype5_production_schedule] also accepts the schedule filters limit (default 20), past, include_past, from, to, month, status and offset. An archived production shows past performances unless past or include_past is given.

Visibility: nothing is shown for a production that is not published, unless the current user may read it. For a password-protected production, until the visitor enters the password, [hype5_production] shows the title and WordPress's password form, [hype5_production_title] shows the title, and every other production shortcode shows nothing.

On a page other than the production's own page (Theater 0.7.0) the production shortcodes and blocks show a production's details only while it is public to everyone — published without a password, in its original language and in the reader's language — or to people who may read it while it carries no password (an editor previewing a draft, a member of a private production). A password-protected production shows the title and the password form there also after the visitor entered the password; the form takes the visitor to the production's own page, where it unlocks. Such pages therefore never depend on a visitor's password and stay safe for page caches. The same holds for WordPress's own readers outside the production's page: feeds, archives, search results and core REST answers show a production with a password as protected also after the password was entered. [hype5_schedule production="…"] follows the same rule; a schedule that the page's address itself filters to one production (?hype5_production=…) follows the production's own page and is sent with no-cache headers (inside a REST request the parameter does not scope it).

A published translation whose original-language production is unpublished shows only its title (and poster) — on its own page, in feeds, core REST answers and search — to visitors who may not read the original.

Person shortcodes

Shortcode Output
[hype5_person] The full profile: hero and sections.
[hype5_person_name] Name.
[hype5_person_meta] Facts: birth date, professions.
[hype5_person_image] Portrait.
[hype5_person_bio] Biography.
[hype5_person_gallery] Profile gallery and tagged images from public productions.
[hype5_person_current_productions] (alias [hype5_person_active_roles]) Productions that are not archived, with the person's credits.
[hype5_person_past_productions] (alias [hype5_person_past_roles]) Archived productions, with the person's credits.

Attributes: id; layout — profile (profile, editorial, minimal), gallery (masonry, grid, carousel, feature), current productions (cards, list, compact), past productions (timeline, list, compact), meta (inline, stacked); and the person display options.

Visibility: nothing is shown for a person who is not published or whose profile page is not allowed, unless the current user may edit the person. Productions listed on a profile are only those published without a password.

Display options

Every key below can be used as an attribute; the first value is the built-in default.

Key Values
style_mode hype5, hybrid, minimal
production_layout, person_layout see layouts above
meta_layout inline, stacked
hero_height / hero_overlay medium, large, fullscreen / medium, light, strong
hero_align / hero_vertical left, center / bottom, center
image_width wide, content
cast_images small, none, large
schedule_group, global_schedule_group month, city, none
price_mode, global_price_mode from_lowest, range, hide
important_info automatic, hidden
gallery_people lightbox, never, under
gallery_fit / gallery_columns natural, cover / 3, 2, 4
accessibility_mode labels, icons, text
profession_separator dot, comma, slash
collection_per_page 12, 24, 48
collection_count filtered, always, never
collection_group year, none
production_order auto, next, title, manual, premiere_asc, premiere_desc
people_order sort_name, title
directory_fit natural, cover
1 / 0 switches gallery_lightbox, gallery_captions, gallery_credits, image_credits, cast_character, cast_profession, cast_affiliation, cast_links, partners_group, card_image, card_teaser, card_meta, card_next, person_birth, person_professions, person_image, person_lightbox (all default 1)

Layout keys (*_layout) accept the registered layouts of their family, including add-on layouts.

Examples

[hype5_productions context="archive" order="premiere_desc" layout="list" filters="0"]
[hype5_people profession="actor" layout="alphabetical" per_page="24"]
[hype5_schedule venue="42" range="month" group_by="none" filters="0"]
[hype5_production id="487" layout="poster"]
[hype5_production_cast id="487" images="none" cast_character="0"]
[hype5_person_past_productions id="483" layout="timeline"]