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

30 lines
1,022 B
PHP

<?php
namespace MediaWiki\Hook;
// phpcs:disable Squiz.Classes.ValidClassName.NotCamelCaps
use Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "CategoryViewer::generateLink" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface CategoryViewer__generateLinkHook {
/**
* This hook is called before generating an output link allow
* extensions opportunity to generate a more specific or relevant link.
*
* @since 1.35
*
* @param string $type Category type, either 'page', 'img', or 'subcat'
* @param Title $title Categorized page
* @param string $html Requested HTML content of anchor
* @param string &$link Returned value. When set to a non-null value by a hook subscriber,
* this value will be used as the anchor instead of Linker::link.
* @return bool|void True or no return value to continue or false to abort
*/
public function onCategoryViewer__generateLink( $type, $title, $html, &$link );
}