diff --git a/docs/src/content/docs/pl/plugins/hooks.mdx b/docs/src/content/docs/pl/plugins/hooks.mdx new file mode 100644 index 00000000..cfa1e225 --- /dev/null +++ b/docs/src/content/docs/pl/plugins/hooks.mdx @@ -0,0 +1,86 @@ +--- +title: Hooks reference +--- + +Hooks are methods of the Plugin class, they are executed in parts of the +Castopod codebase. + +## List + +| Hooks | Executes in | +| ---------------- | ----------- | +| rssBeforeChannel | RSS Feed | +| rssAfterChannel | RSS Feed | +| rssBeforeItem | RSS Feed | +| rssAfterItem | RSS Feed | +| siteHead | Website | + +### rssBeforeChannel + +This hook is executed just before rendering the `` tag in the Podcast +RSS feed using the given Podcast object. + +Here is a good place to alter the Podcast object. + +```php +public function rssBeforeChannel(Podcast $podcast): void +{ + // … +} +``` + +### rssAfterChannel + +This hook is executed after rendering all of the `` tags in the Podcast +RSS feed. + +Here is a good place to add new tags to the generated channel. + +```php +public function rssAfterChannel(Podcast $podcast, SimpleRSSElement $channel): void +{ + // … +} +``` + +### rssBeforeItem + +This hook is executed before rendering an `` tag in the Podcast RSS feed +using the given Episode object. + +Here is a good place to alter the Episode object. + +```php +public function rssBeforeItem(Episode $episode): void +{ + // … +} +``` + +### rssAfterItem + +This hook is executed after rendering an ``'s tags in the Podcast RSS +feed. + +Here is a good place to add new tags to the generated item. + +```php +public function rssAfterItem(Epsiode $episode, SimpleRSSElement $item): void +{ + // … +} +``` + +### siteHead + +This hook is executed in the public pages' `` tag. + +This is a good place to add meta tags and third-party scripts to Castopod's +public pages. + +```php +public function siteHead(): void +{ + // … +} +```