aboutsummaryrefslogtreecommitdiffstats
path: root/includes/diff/Hook/DifferenceEngineRenderRevisionAddParserOutputHook.php
blob: b44ba3bf117d046cd178f8537483316322d98642 (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
31
32
33
<?php

namespace MediaWiki\Diff\Hook;

use DifferenceEngine;
use MediaWiki\Output\OutputPage;
use MediaWiki\Parser\ParserOutput;
use WikiPage;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "DifferenceEngineRenderRevisionAddParserOutput" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface DifferenceEngineRenderRevisionAddParserOutputHook {
	/**
	 * Use this hook to change the parser output.
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $differenceEngine
	 * @param OutputPage $out
	 * @param ParserOutput $parserOutput
	 * @param WikiPage $wikiPage
	 * @return bool|void True or no return value to continue, or false to not add parser output via
	 *   OutputPage's addParserOutput method
	 */
	public function onDifferenceEngineRenderRevisionAddParserOutput(
		$differenceEngine, $out, $parserOutput, $wikiPage
	);
}