MediaWiki\Api\Hook\ApiOptionsHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. 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.

Detailed Description

This is a hook handler interface, see docs/Hooks.md.

Use the hook name "ApiOptions" to register handlers implementing this interface.

Stability: stable

to implement

Definition at line 15 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	$apiModule	Calling ApiOptions object
User	$user	User object whose preferences are being changed
array	$changes	Associative array of preference name => value
string[]	$resetKinds	Array 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:

• includes/api/Hook/ApiOptionsHook.php