aboutsummaryrefslogtreecommitdiffstats
path: root/includes/diff/Hook/DifferenceEngineMarkPatrolledLinkHook.php
blob: f7ffa2df922418550b88b5688d3cc5f0a6d5ab4b (plain) (blame)
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
30
<?php

namespace MediaWiki\Diff\Hook;

use DifferenceEngine;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "DifferenceEngineMarkPatrolledLink" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface DifferenceEngineMarkPatrolledLinkHook {
	/**
	 * Use this hook to change the "mark as patrolled" link which is shown both
	 * on the diff header as well as on the bottom of a page, usually wrapped in
	 * a span element which has class="patrollink".
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $differenceEngine
	 * @param string &$markAsPatrolledLink "Mark as patrolled" link HTML
	 * @param int $rcid Recent change ID (rc_id) for this change
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onDifferenceEngineMarkPatrolledLink( $differenceEngine,
		&$markAsPatrolledLink, $rcid
	);
}