Skip to main content

Filter Hooks Reference

All filter hooks provided by Benecaster. Each area below has its own page, and each hook name there links to its reference page with full parameter docs, return type, usage notes, and code examples.

Unless noted otherwise, every filter here fires on any install.

The number after each area is how many filters it lists.

Benecaster

Area What it covers
Feed (15) Filter what goes into a feed’s compiled RSS XML — the episode list, per-episode data, enclosure URLs, Podcasting 2.0 tags, and the final XML string itself.
Subscriber Engagement (1) Controls the inactivity threshold used to decide when a subscriber’s feed is considered stopped.
SSP / PowerPress Import (1) Filters the arguments used to insert a draft episode while importing from Seriously Simple Podcasting.
Episodes (14) 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.
Templates — Episode Page (4) Filter the custom fields shown on an episode page and the previous/next navigation links and subscribe fallback text.
Episode Page Blocks (16) Register, reorder, or replace the rendered HTML of the blocks that make up an episode page — related episodes, navigation, share buttons, social links, and platform links — and the shortcodes that mirror several of them.
Templates — Episode Archive (11) Filter the text, HTML, and per-card data rendered on the episode archive listing.
Episode Search (7) Filter the episode search query, its results, and what’s eligible to be indexed — including a short-circuit for replacing Benecaster’s own search entirely. The tiers these filters receive is every slug the searcher holds on the show — tier, buy-up and grant — or ['public'].
Webhooks and Integrations (2) Shape what Benecaster sends to an outside system, and what it answers when an outside system calls an add-on.
Marketing Consent (1) Offer an unticked marketing-consent checkbox on the subscribe and follower sign-up forms.
Data Export (2) Register additional sheets, or filter row data for an existing one, in the “Your Data” XLSX export.
Member Thanks (2) Register query strategies for, or filter the rendered HTML of, the [benecaster_member_thanks] shortcode.
Custom Fields (2) Filter custom field group definitions before they render, and individual field values before they’re returned to the caller.
References (1) Filters the reference group list for a show before it’s returned in REST responses.
Admin UI (8) Register or modify what appears in the Benecaster admin — your add-on’s own screens and side panels, dashboard cards, episode editor tabs, and show settings pages and sections.
Email (14) Filter any part of an outgoing Benecaster email — whether it sends, its subject and body, its headers, its merge tags, its header/footer branding, a stored design that replaces its template, and which types are exempt from broadcast opt-out suppression.
Shortcode Output (18) Filter the final rendered HTML of most Benecaster shortcodes, one filter per shortcode.
Account Page (5) Filter the subscriber account page’s URL and the labels Benecaster adds to other membership plugins’ own account screens.
Templates — Show Page (9) Filter the text, HTML, and query arguments rendered on the public show page — header, subscribe links, tiers, embedded episode list, and public stats.
Token and Access (3) Filter the tier a user resolves to for a show, and the teaser content shown to someone who can’t access a locked episode.
Setup and Configuration (3) Filter the setup wizard’s step list and bridge options, and register runtime setup-guidance notices for add-ons.
Maintenance (2) Filter retention windows used by Benecaster’s own cleanup jobs — imported shadow records and the email log.

Add-ons

These fire only while the named add-on is installed and active.

Area What it covers
Add-on Manager (3) Filter what the Add-on Manager shows. None of them can change what is downloaded, where it comes from, or whether its signature is checked.
Migration Wizard (14) Filter the wizard’s steps, the migration dashboard, the migration emails and their links, and the daily grace-period pass.
Blocks & Widgets Library (1) Change what a Benecaster block or Elementor widget renders.
Outlinks (5) Filter how Outlinks counts clicks, its affiliate disclosure line, and Link Health’s notice and email digest.
AI Search (12) Change what the search box shows and returns, the limits on paid searches, who may search, pinned results, locked results and the production panel.
Analytics Dashboard (15) Change the data behind each Analytics Dashboard report (growth, tiers, revenue, donations, downloads, feed health, cohorts, win-back, email engagement and the migration funnel) and the digest email.
Email Editor (11) Change the Email Editor’s designs and wrapper, saved versions, exports, link parameters, the player card image, episode-notification recipients and open and click tracking.
Guest Manager (16) Change a guest’s page, the guest directory, the guest shortcodes, the Guest portal’s form and emails, and what other add-ons read about a guest.
Transcription Service (10) Change the transcription providers and their rates, the language and prompt sent, who can see a transcript, how it is shown, locked and downloaded, and the chapter suggestions it offers.

See Also

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