MediaWiki master
MediaWiki\User\Options\Hook\LoadUserOptionsHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onLoadUserOptions (UserIdentity $user, array &$options)
 This hook is called when user options/preferences are being loaded from the database.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 14 of file LoadUserOptionsHook.php.

Member Function Documentation

◆ onLoadUserOptions()

MediaWiki\User\Options\Hook\LoadUserOptionsHook::onLoadUserOptions ( UserIdentity $user,
array & $options )

This hook is called when user options/preferences are being loaded from the database.

Since
1.37
Parameters
UserIdentity$user
array&$optionsOptions, can be modified.
Returns
void This hook must not abort, it must return no value

Implemented in MediaWiki\HookContainer\HookRunner.


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