MediaWiki  master
MediaWiki\Hook\SelfLinkBeginHook Interface Reference

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

Inheritance diagram for MediaWiki\Hook\SelfLinkBeginHook:

Public Member Functions

 onSelfLinkBegin ( $nt, &$html, &$trail, &$prefix, &$ret)
 This hook is called before a link to the current article is displayed to allow the display of the link to be customized. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file SelfLinkBeginHook.php.

Member Function Documentation

◆ onSelfLinkBegin()

MediaWiki\Hook\SelfLinkBeginHook::onSelfLinkBegin (   $nt,
$html,
$trail,
$prefix,
$ret 
)

This hook is called before a link to the current article is displayed to allow the display of the link to be customized.

Since
1.35
Parameters
Title$nt
string&$htmlHTML to display for the link
string&$trailOptional text to display before $html
string&$prefixOptional text to display after $html
string&$retValue to return if your hook returns false
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: