Episodes Filters
Filters for Episodes. Every other area is listed on the Filter Hooks Reference. Each name links to its own page, with its parameters, notes and an example.
Filter an episode’s resolved data — its iTunes type, description, audio/video URLs and players, share links, and whether it’s accessible to the current user.
| Filter | Description |
|---|---|
benecaster_episode_auto_number |
Filters the auto-assigned episode number when an episode is first published |
benecaster_episode_itunes_type |
Filters the resolved iTunes canonical type for an episode during feed compilation |
benecaster_episode_description |
Filters the episode description HTML rendered on the front-end episode page (distinct from benecaster_episode_description_rss which filters the RSS feed description) |
benecaster_episode_audio_url |
Filters the audio file URL used in the front-end player and episode page |
benecaster_episode_embed_audio |
Filters the rendered HTML for the embedded audio player on the episode page |
benecaster_episode_video_url |
Filters the video file URL used in the front-end player and episode page |
benecaster_episode_embed_video |
Filters the rendered HTML for the embedded video player on the episode page and the archive episode card |
benecaster_episode_share_links |
Filters the share links array for an episode; each entry is {label, url, class}; used in the episode/share.php template part |
benecaster_show_episode_player |
Filters whether the episode player is rendered on the episode page; return false to suppress the player entirely (locked-state template still renders) |
benecaster_show_episode_content |
Filters whether the episode page shows the full show notes or the teaser; args (bool $show_content, int $episode_id, ?int $user_id, ?string $user_tier) |
benecaster_show_episode_download |
Filters whether the “Download episode” link is shown on the episode page, starting from the episode’s setting (the video-only one for an episode whose only file is a video); args (bool $show, int $episode_id, ?int $user_id, ?string $user_tier). The filter can only hide the link: returning true for a visitor without access has no effect. |
benecaster_show_episode_transcript |
Filters whether the “Read the transcript” link is shown on the episode page; same arguments as the download filter, and it can likewise only hide the link |
benecaster_episode_is_accessible |
Overrides episode access for custom rules; args (bool $can_access, int $episode_id, int $user_id, string $tier_slug) where $tier_slug is the subscriber’s active token tier or '' when no token; return false to lock, true to grant access regardless of tier; fires inside benecaster_user_can_access_episode(), so it decides the feed, downloads, and the website’s [benecaster_player], [benecaster_episodes], [benecaster_latest_episode] and [benecaster_related_episodes] alike — returning false locks the player too, even for a public episode |
benecaster_episode_move_effects |
Adds plain-text lines the move dialog lists under Benecaster’s own, saying what an add-on will do when the episode moves; it describes a move and can’t block one; args (array $lines, int $episode_id, int $from_show_id, int $to_show_id) |
benecaster_episode_move_blockers |
Adds reasons an episode can’t be moved to another show yet; Benecaster’s own blockers always stay; args (array $blockers, int $episode_id, int $from_show_id, int $to_show_id) |
benecaster_episode_publish_check |
Refuses a publish or a schedule until the episode is ready, on every path that publishes; return a WP_Error whose message the podcaster sees; args (true|WP_Error $allowed, int $episode_id, array $context). An administrator can publish anyway; at the scheduled time a refusal holds the episode as a draft |
benecaster_episode_preview_access |
Lets [benecaster_player] play a draft, pending or scheduled episode in full to one visitor, for a preview link your plugin issues and validates; default false; args (bool $allowed, WP_Post $episode). Never reaches a feed, the download link or benecaster_user_can_access_episode() |
See Also
Need this built rather than just documented? See our services →