wiki.techinc.nl/includes/parser/Hook/GetLinkColoursHook.php
apaskulin c44488f725 docs: Hook interface doc comment review
Edited doc comments for hook interfaces to improve
consistency and add type hints.

Bug: T246855
Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
2020-04-21 09:10:08 +10:00

24 lines
670 B
PHP

<?php
namespace MediaWiki\Hook;
use Title;
/**
* @stable for implementation
* @ingroup Hooks
*/
interface GetLinkColoursHook {
/**
* Use this hook to modify the CSS class of an array of page links.
*
* @since 1.35
*
* @param array $linkcolour_ids Array of prefixed DB keys of the pages linked to,
* indexed by page_id
* @param array &$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 );
}