wiki.techinc.nl/includes/Hook/OutputPageMakeCategoryLinksHook.php
daniel 2e57447c58 Document hook names in hook interfaces.
Bug: T258665
Change-Id: Ifddbf57f8aa2e3eb0d5845601376cbafa08ed407
2020-09-27 12:03:12 +02:00

29 lines
999 B
PHP

<?php
namespace MediaWiki\Hook;
use OutputPage;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "OutputPageMakeCategoryLinks" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface OutputPageMakeCategoryLinksHook {
/**
* This hook is called when links are about to be generated for the page's categories.
*
* @since 1.35
*
* @param OutputPage $out
* @param string[] $categories Associative array in which keys are category names and
* values are category types ("normal" or "hidden")
* @param array &$links Intended to hold the result. Associative array with
* category types as keys and arrays of HTML links as values.
* @return bool|void True or no return value to continue. Implementations should return
* false if they generate the category links, so the default link generation is skipped.
*/
public function onOutputPageMakeCategoryLinks( $out, $categories, &$links );
}