MediaWiki\Hook\CategoryViewer__generateLinkHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onCategoryViewer__generateLink ( $type, $title, $html, &$link)
	This hook is called before generating an output link allow extensions opportunity to generate a more specific or relevant link.

Detailed Description

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

Use the hook name "CategoryViewer::generateLink" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 of file CategoryViewer__generateLinkHook.php.

Member Function Documentation

onCategoryViewer__generateLink()

MediaWiki\Hook\CategoryViewer__generateLinkHook::onCategoryViewer__generateLink	(		$type,
			$title,
			$html,
		&	$link )

This hook is called before generating an output link allow extensions opportunity to generate a more specific or relevant link.

Since

1.35

Parameters

string	$type	Category type, either 'page', 'file', or 'subcat'
Title	$title	Categorized page
string	$html	Requested HTML content of anchor
string	&$link	Returned value. When set to a non-null value by a hook subscriber, this value will be used as the anchor instead of LinkRenderer::makeLink.

Returns

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

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/Hook/CategoryViewer__generateLinkHook.php