MediaWiki\Hook\OutputPageMakeCategoryLinksHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Hook\OutputPageMakeCategoryLinksHook:

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

Stable to implement.

Definition at line 11 of file OutputPageMakeCategoryLinksHook.php.

Member Function Documentation

onOutputPageMakeCategoryLinks()

MediaWiki\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/Hook/OutputPageMakeCategoryLinksHook.php