aboutsummaryrefslogtreecommitdiffstats
path: root/includes/recentchanges/Hook/FetchChangesListHook.php
blob: d31be547f7ba3a1e159845f8f2a3d6a264b399ec (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
<?php

namespace MediaWiki\Hook;

use MediaWiki\RecentChanges\ChangesList;
use MediaWiki\RecentChanges\ChangesListFilterGroup;
use MediaWiki\Skin\Skin;
use MediaWiki\User\User;

/**
 * This is a hook handler interface, see docs/Hooks.md.
 * Use the hook name "FetchChangesList" to register handlers implementing this interface.
 *
 * @stable to implement
 * @ingroup Hooks
 */
interface FetchChangesListHook {
	/**
	 * This hook is called when fetching the ChangesList derivative for a particular user.
	 *
	 * @since 1.35
	 *
	 * @param User $user User the list is being fetched for
	 * @param Skin $skin Skin object to be used with the list
	 * @param ChangesList|null &$list Defaults to NULL. Change it to an object instance and
	 *   return false to override the list derivative used.
	 * @param ChangesListFilterGroup[] $groups Added in 1.34
	 * @return bool|void True or no return value to continue, or false to override the list
	 *   derivative used
	 */
	public function onFetchChangesList( $user, $skin, &$list, $groups );
}