Skip to main content

Templates — Locked State Actions

Actions for Templates — Locked State. Every other area is listed on the Action Hooks Reference. Each name links to its own page, with its parameters, notes and an example.

Bracket the messages shown to visitors who can’t access an episode — the generic locked message, the upgrade prompt for logged-in subscribers at the wrong tier, and the login prompt for logged-out visitors.

Hook Description
benecaster_before_locked_message Fires before the locked state message renders in the player or content area; receives $episode_id (int), $show_id (int)
benecaster_after_locked_message Fires after the locked state message closes; receives $episode_id (int), $show_id (int)
benecaster_before_upgrade_prompt Fires before the upgrade prompt renders (shown to logged-in subscribers at wrong tier); receives $episode_id (int), $show_id (int), $required_tier (string), $user_tier (string)
benecaster_after_upgrade_prompt Fires after the upgrade prompt closes; same args as above
benecaster_before_login_prompt Fires before the login prompt renders (shown to logged-out visitors); receives $episode_id (int), $show_id (int)
benecaster_after_login_prompt Fires after the login prompt closes; receives $episode_id (int), $show_id (int)

See Also

Need this built rather than just documented? See our services →