Manual:Hooks/UserToggles
 | This feature was removed from MediaWiki core in version 1.17.0. Please see GetPreferences for an alternative way to use this feature. |
| UserToggles | |
|---|---|
| Available from version 1.8.0 Removed in version 1.17.0Category:Removed hooks#UserToggles Provides an opportunity to dynamically add user toggles | |
| Define function: | public static function onUserToggles( &$extraToggles ) { ... }
|
| Attach hook: | In extension.json:
{
"Hooks": {
"UserToggles": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserToggles"
}
}
|
| Called from: | File(s): User.phpCategory:MediaWiki hooks included in User.php#UserToggles |
| Interface: | UserTogglesHook.php |
For more information about attaching hooks, see Manual:Hooks.
For examples of extensions using this hook, see Category:UserToggles extensions.
Background
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
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.