aboutsummaryrefslogtreecommitdiffstats
path: root/includes/diff/Hook/DifferenceEngineShowDiffHook.php
blob: 2dae763acf1bc484a9c54440752e13e8dc4e1445 (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
<?php

namespace MediaWiki\Diff\Hook;

use DifferenceEngine;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "DifferenceEngineShowDiff" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface DifferenceEngineShowDiffHook {
	/**
	 * Use this hook to affect the diff text which eventually gets sent to the OutputPage object.
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $differenceEngine
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onDifferenceEngineShowDiff( $differenceEngine );
}