MediaWiki  master
MediaWiki\Api\Hook\ApiOptionsHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Api\Hook\ApiOptionsHook:

Public Member Functions

 onApiOptions ( $apiModule, $user, $changes, $resetKinds)
 This hook is called by action=options before applying changes to user preferences. More...
 

Detailed Description

Stable to implement.

Definition at line 12 of file ApiOptionsHook.php.

Member Function Documentation

◆ onApiOptions()

MediaWiki\Api\Hook\ApiOptionsHook::onApiOptions (   $apiModule,
  $user,
  $changes,
  $resetKinds 
)

This hook is called by action=options before applying changes to user preferences.

Since
1.35
Parameters
ApiOptions$apiModuleCalling ApiOptions object
User$userUser object whose preferences are being changed
array$changesAssociative array of preference name => value
string[]$resetKindsArray of strings specifying which options kinds to reset See User::resetOptions() and User::getOptionKinds() for possible values.
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\Api\ApiHookRunner.


The documentation for this interface was generated from the following file: