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

namespace MediaWiki\Diff\Hook;

use DifferenceEngine;
use MediaWiki\Output\OutputPage;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "ArticleContentOnDiff" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface ArticleContentOnDiffHook {
	/**
	 * This hook is called before showing the article content below a diff. Use
	 * this hook to change the content in this area or how it is loaded.
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $diffEngine
	 * @param OutputPage $output
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onArticleContentOnDiff( $diffEngine, $output );
}