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

27 lines
817 B
PHP

<?php
namespace MediaWiki\Hook;
use Title;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "GetLinkColours" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface GetLinkColoursHook {
/**
* Use this hook to modify the CSS class of an array of page links.
*
* @since 1.35
*
* @param string[] $linkcolour_ids Array of prefixed DB keys of the pages linked to,
* indexed by page_id
* @param string[] &$colours (Output) Array of CSS classes, indexed by prefixed DB keys
* @param Title $title Title of the page being parsed, on which the links will be shown
* @return bool|void True or no return value to continue or false to abort
*/
public function onGetLinkColours( $linkcolour_ids, &$colours, $title );
}