MediaWiki\Output\Hook\OutputPageMakeCategoryLinksHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onOutputPageMakeCategoryLinks ( $out, $categories, &$links)
	This hook is called when links are about to be generated for the page's categories.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file OutputPageMakeCategoryLinksHook.php.

Member Function Documentation

onOutputPageMakeCategoryLinks()

MediaWiki\Output\Hook\OutputPageMakeCategoryLinksHook::onOutputPageMakeCategoryLinks	(		$out,
			$categories,
		&	$links )

This hook is called when links are about to be generated for the page's categories.

Since

1.35

Parameters

OutputPage	$out
string[]	$categories	Associative array in which keys are category names and values are category types ("normal" or "hidden")
array	&$links	Intended to hold the result. Associative array with category types as keys and arrays of HTML links as values.

Returns

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.

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Output/Hook/OutputPageMakeCategoryLinksHook.php