Manual:Hooks/UserToggles
From MediaWiki.org
| This feature was removed completely in version 1.17.0. |
| UserToggles | |
|---|---|
| Available from version 1.8.0 Removed in version 1.17.0 Provides an opportunity to dynamically add user toggles |
|
Define function: |
public static function onUserToggles( &$extraToggles ) { ... }
|
Attach hook: |
$wgHooks['UserToggles'][] = 'MyExtensionHooks::onUserToggles'; |
| Called from: | User.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:UserToggles extensions.
Background [edit]
The MediaWiki special page Special:Preferences contains a number of checkboxes. The values for these check boxes come from two sources:
- a list of hard coded toggles defined in User.php
- toggles added dynamically via the
UserToggleshook.
Details [edit]
Implementers add their dynamically generated toggles by adding elements to $extraToggles. The array consists of a list of system messages, each of which identifies the user toggle and its accompanying localized check box message.
This hook is now removed. Please use GetPreferences instead.