aboutsummaryrefslogtreecommitdiffstats
path: root/includes/diff/Hook/DifferenceEngineShowDiffPageMaybeShowMissingRevisionHook.php
blob: 0f56ac2a352f4e5a85f5d698c18c1f7d5a875005 (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 "DifferenceEngineShowDiffPageMaybeShowMissingRevision" to register
 * handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface DifferenceEngineShowDiffPageMaybeShowMissingRevisionHook {
	/**
	 * This hook is called in DifferenceEngine::showDiffPage() when revision
	 * data cannot be loaded.
	 *
	 * @since 1.35
	 *
	 * @param DifferenceEngine $differenceEngine
	 * @return bool|void True or no return value to continue, or false to
	 *   prevent displaying the missing revision message (i.e. to prevent
	 *   DifferenceEngine::showMissingRevision() from being called)
	 */
	public function onDifferenceEngineShowDiffPageMaybeShowMissingRevision(
		$differenceEngine
	);
}