c44488f725
Edited doc comments for hook interfaces to improve consistency and add type hints. Bug: T246855 Change-Id: I38fa802463cd6f39bf5946dbbeb1b3ebaea604b2
29 lines
817 B
PHP
29 lines
817 B
PHP
<?php
|
|
|
|
namespace MediaWiki\Hook;
|
|
|
|
use ChangesList;
|
|
use ChangesListFilterGroup;
|
|
use Skin;
|
|
use User;
|
|
|
|
/**
|
|
* @stable for implementation
|
|
* @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 to override the list
|
|
* derivative used
|
|
*/
|
|
public function onFetchChangesList( $user, $skin, &$list, $groups );
|
|
}
|