Hooks reference

Hooks are methods of the Plugin class, they are executed in parts of the Castopod codebase.

List

This hook is executed just before rendering the <channel> tag in the Podcast RSS feed using the given Podcast object.

Here is a good place to alter the Podcast object.

public function rssBeforeChannel(Podcast $podcast): void
{
    // …
}

This hook is executed after rendering all of the <channel> tags in the Podcast RSS feed.

Here is a good place to add new tags to the generated channel.

public function rssAfterChannel(Podcast $podcast, SimpleRSSElement $channel): void
{
    // …
}

This hook is executed before rendering an <item> tag in the Podcast RSS feed using the given Episode object.

Here is a good place to alter the Episode object.

public function rssBeforeItem(Episode $episode): void
{
    // …
}

This hook is executed after rendering an <item>’s tags in the Podcast RSS feed.

Here is a good place to add new tags to the generated item.

public function rssAfterItem(Epsiode $episode, SimpleRSSElement $item): void
{
    // …
}

This hook is executed in the public pages’ <head> tag.

This is a good place to add meta tags and third-party scripts to Castopod’s public pages.

public function siteHead(): void
{
    // …
}