aboutsummaryrefslogtreecommitdiffstats
path: root/includes/recentchanges/Hook/EnhancedChangesListModifyLineDataHook.php
blob: dd91bcb766b5c2d602a1fd3aa5035ab678f73ee8 (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
34
35
36
<?php

namespace MediaWiki\Hook;

use MediaWiki\RecentChanges\EnhancedChangesList;
use MediaWiki\RecentChanges\RecentChange;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "EnhancedChangesListModifyLineData" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface EnhancedChangesListModifyLineDataHook {
	/**
	 * Use this hook to alter data used to build a grouped recent change inner line in
	 * EnhancedChangesList.
	 *
	 * @since 1.35
	 *
	 * @param EnhancedChangesList $changesList
	 * @param array &$data Array of components that will be joined in order to create the line
	 * @param RecentChange[] $block Array of RecentChange objects in that block
	 * @param RecentChange $rc RecentChange object for this line
	 * @param string[] &$classes Array of classes to change
	 * @param string[] &$attribs Associative array of other HTML attributes for the `<tr>` element.
	 *   Currently only data attributes reserved to MediaWiki are allowed
	 *   (see Sanitizer::isReservedDataAttribute).
	 * @return bool|void True or no return value to continue, or false to omit this line from
	 *   recentchanges
	 */
	public function onEnhancedChangesListModifyLineData( $changesList, &$data,
		$block, $rc, &$classes, &$attribs
	);
}