MediaWiki\User\Options\Hook\LocalUserOptionsStoreSaveHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onLocalUserOptionsStoreSave (UserIdentity $user, array $oldOptions, array $newOptions)
	This hook is called just after saving preferences in LocalUserOptionsStore.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file LocalUserOptionsStoreSaveHook.php.

Member Function Documentation

onLocalUserOptionsStoreSave()

MediaWiki\User\Options\Hook\LocalUserOptionsStoreSaveHook::onLocalUserOptionsStoreSave	(	UserIdentity	$user,
		array	$oldOptions,
		array	$newOptions )

This hook is called just after saving preferences in LocalUserOptionsStore.

Hook handlers cannot modify the new preferences as the changes have been saved. This will only allow handlers to see the changes in specifically local options storage as opposed to any storge (which would be handled using SaveUserOptionsHook).

Since

1.45

Parameters

UserIdentity	$user	The user for which the options have been saved
array	$oldOptions	The user's old local options
array	$newOptions	The user's new local options

Returns

void

Implemented in MediaWiki\HookContainer\HookRunner.

---

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

• includes/User/Options/Hook/LocalUserOptionsStoreSaveHook.php