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\Api\Hook;
use MediaWiki\Api\ApiOptions;
use MediaWiki\User\User;
/**
* This is a hook handler interface, see docs/Hooks.md.
* Use the hook name "ApiOptions" to register handlers implementing this interface.
*
* @stable to implement
* @ingroup Hooks
*/
interface ApiOptionsHook {
/**
* This hook is called by action=options before applying changes to user
* preferences.
*
* @since 1.35
*
* @param ApiOptions $apiModule Calling ApiOptions object
* @param User $user User object whose preferences are being changed
* @param array $changes Associative array of preference name => value
* @param string[] $resetKinds Array of strings specifying which options kinds to reset
* See User::resetOptions() and User::getOptionKinds() for possible values.
* @return bool|void True or no return value to continue or false to abort
*/
public function onApiOptions( $apiModule, $user, $changes, $resetKinds );
}
|
