MediaWiki  master
MediaWiki\User\Hook\UserLoadOptionsHook Interface Reference

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

Inheritance diagram for MediaWiki\User\Hook\UserLoadOptionsHook:

Public Member Functions

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

Detailed Description

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

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

Stable to implement

Definition at line 14 of file UserLoadOptionsHook.php.

Member Function Documentation

◆ onUserLoadOptions()

MediaWiki\User\Hook\UserLoadOptionsHook::onUserLoadOptions (   $user,
$options 
)

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

Since
1.35
Parameters
User$user
array&$optionsOptions, can be modified.
Returns
bool|void True or no return value to continue or false to abort

Implemented in MediaWiki\HookContainer\HookRunner.


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