Episode Search Filters
Filters for Episode Search. 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 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'].
| Filter | Description |
|---|---|
benecaster_search_query_args |
Filters the query arguments before the episode search runs |
benecaster_search_pre_results |
Short-circuit the episode search; return a non-null array to skip Benecaster’s own query and return custom results |
benecaster_search_results |
Filters the final episode search result set and pagination metadata |
benecaster_search_result_excerpt |
Filters the search result excerpt string; <mark> wrapping around matched terms is already applied |
benecaster_search_indexable |
Controls whether a specific episode is included in search results; return false to exclude |
benecaster_search_output |
Filters the rendered HTML output of [benecaster_search] |
benecaster_search_supplemental_episode_ids |
Adds supplemental episode IDs to merge into search results via OR p.ID IN (...) (e.g. transcript matches from the Transcription add-on); receives the searcher’s $holdings and $user_id — gate buy-up content on $holdings |
See Also
Need this built rather than just documented? See our services →