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. | |
Detailed Description
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "SelfLinkBegin" to register handlers implementing this interface.
- Stability: 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 &$html HTML to display for the link string &$trail Optional text to display before $html string &$prefix Optional text to display after $html string &$ret Value 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:
- includes/Hook/SelfLinkBeginHook.php
