MediaWiki  master
MediaWiki\Preferences\Hook\GetPreferencesHook Interface Reference

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

Inheritance diagram for MediaWiki\Preferences\Hook\GetPreferencesHook:

Public Member Functions

 onGetPreferences ( $user, &$preferences)
 Use this hook to modify user preferences. More...
 

Detailed Description

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

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

Stable to implement

Definition at line 14 of file GetPreferencesHook.php.

Member Function Documentation

◆ onGetPreferences()

MediaWiki\Preferences\Hook\GetPreferencesHook::onGetPreferences (   $user,
$preferences 
)

Use this hook to modify user preferences.

Since
1.35
Parameters
User$userUser whose preferences are being modified
array&$preferencesPreferences description array, to be fed to an HTMLForm object
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: