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

namespace MediaWiki\Diff\Hook;

use DifferenceEngine;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "DifferenceEngineLoadTextAfterNewContentIsLoaded" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface DifferenceEngineLoadTextAfterNewContentIsLoadedHook {
	/**
	 * This hook is called in DifferenceEngine::loadText() after the new revision's content
	 * has been loaded into the class member variable $differenceEngine->mNewContent but before
	 * checking if the variable's value is null. Use this hook to inject content into said
	 * class member variable.
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $differenceEngine
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onDifferenceEngineLoadTextAfterNewContentIsLoaded(
		$differenceEngine
	);
}