MediaWiki\Linker\Hook\HtmlPageLinkRendererEndHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onHtmlPageLinkRendererEnd ( $linkRenderer, $target, $isKnown, &$text, &$attribs, &$ret)
	This hook is called when generating internal and interwiki links in LinkRenderer, just before the function returns a value.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 16 of file HtmlPageLinkRendererEndHook.php.

Member Function Documentation

onHtmlPageLinkRendererEnd()

MediaWiki\Linker\Hook\HtmlPageLinkRendererEndHook::onHtmlPageLinkRendererEnd	(		$linkRenderer,
			$target,
			$isKnown,
		&	$text,
		&	$attribs,
		&	$ret )

This hook is called when generating internal and interwiki links in LinkRenderer, just before the function returns a value.

Since

1.35

Parameters

LinkRenderer	$linkRenderer
LinkTarget	$target	LinkTarget object that the link is pointing to
bool	$isKnown	Whether the page is known or not
string | HtmlArmor	&$text	Contents that the <a> tag should have; either a plain, unescaped string or an HtmlArmor object
string[]	&$attribs	Final HTML attributes of the <a> tag, after processing, in associative array form
string	&$ret	Value to return if your hook returns false

Returns

bool|void True or no return value to continue or false to abort. If you return true, an <a> element with HTML attributes $attribs and contents $html will be returned. If you return false, $ret will be returned.

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/linker/Hook/HtmlPageLinkRendererEndHook.php