aboutsummaryrefslogtreecommitdiffstats
path: root/includes/diff/Hook/TextSlotDiffRendererTablePrefixHook.php
blob: 07b2988785b79ca7895a6aec052f189a8200fdd9 (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 MediaWiki\Context\IContextSource;
use TextSlotDiffRenderer;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "TextSlotDiffRendererTablePrefix" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface TextSlotDiffRendererTablePrefixHook {

	/**
	 * Use this hook to change the HTML that is included in a prefix container directly before the diff table.
	 *
	 * @since 1.41
	 *
	 * @param TextSlotDiffRenderer $textSlotDiffRenderer
	 * @param IContextSource $context
	 * @param (string|null)[] &$parts HTML strings to add to a container above the diff table.
	 * Will be sorted by key before being output.
	 * @return bool|void True or no return value to continue or false to abort
	 */
	public function onTextSlotDiffRendererTablePrefix(
		TextSlotDiffRenderer $textSlotDiffRenderer,
		IContextSource $context,
		array &$parts
	);
}