includes/Hook/SelfLinkBeginHook.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

<?php

namespace MediaWiki\Hook;

use MediaWiki\Title\Title;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "SelfLinkBegin" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface SelfLinkBeginHook {
	/**
	 * 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
	 *
	 * @param Title $nt
	 * @param string &$html HTML to display for the link
	 * @param string &$trail Optional text to display before $html
	 * @param string &$prefix Optional text to display after $html
	 * @param string &$ret Value to return if your hook returns false
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onSelfLinkBegin( $nt, &$html, &$trail, &$prefix, &$ret );
}