MediaWiki\Hook\GetLinkColoursHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\GetLinkColoursHook:

Public Member Functions
	onGetLinkColours ( $linkcolour_ids, &$colours, $title)
	Use this hook to modify the CSS class of an array of page links.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file GetLinkColoursHook.php.

Member Function Documentation

onGetLinkColours()

MediaWiki\Hook\GetLinkColoursHook::onGetLinkColours	(		$linkcolour_ids,
		&	$colours,
			$title
	)

Use this hook to modify the CSS class of an array of page links.

Since

1.35

Parameters

string[]	$linkcolour_ids	Array of prefixed DB keys of the pages linked to, indexed by page_id
string[]	&$colours	(Output) Array of CSS classes, indexed by prefixed DB keys
Title	$title	Title of the page being parsed, on which the links will be shown

Returns

bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner, and MediaWiki\Api\ApiHookRunner.

---

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

• includes/parser/Hook/GetLinkColoursHook.php