MediaWiki master
MediaWiki\Output\Hook\OutputPageRenderCategoryLinkHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. More...

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onOutputPageRenderCategoryLink (OutputPage $outputPage, ProperPageIdentity $categoryTitle, string $text, ?string &$link)
 This hook is called when a category link is rendered.
 

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "OutputPageRenderCategoryLink" to register handlers implementing this interface.

Stability: stable
to implement

Definition at line 15 of file OutputPageRenderCategoryLinkHook.php.

Member Function Documentation

◆ onOutputPageRenderCategoryLink()

MediaWiki\Output\Hook\OutputPageRenderCategoryLinkHook::onOutputPageRenderCategoryLink ( OutputPage $outputPage,
ProperPageIdentity $categoryTitle,
string $text,
?string & $link )

This hook is called when a category link is rendered.

Since
1.43
Parameters
OutputPage$outputPage
ProperPageIdentity$categoryTitleCategory title
string$textHTML escaped category name
?string&$linkHTML of rendered category link which can be replaced by a different HTML
Returns
void This hook must not abort, it must return no value

Implemented in MediaWiki\HookContainer\HookRunner.


The documentation for this interface was generated from the following file: