Manual:Hooks/UserToggles
From Linux Web Expert
| File:OOjs UI icon alert-destructive.svg | <translate> This feature was removed from MediaWiki core in version <tvar name=ver>1.17.0</tvar>.</translate> <translate> Please see <tvar name=page>GetPreferences</tvar> for an alternative way to use this feature.</translate> |
| UserToggles | |
|---|---|
| <translate> Available from <tvar name=1><translate> version <tvar </tvar></translate> <translate> Removed in <tvar name=1><translate> version <tvar </tvar></translate> Provides an opportunity to dynamically add user toggles | |
| <translate> Define function:</translate> | public static function onUserToggles( &$extraToggles ) { ... }
|
| <translate> Attach hook:</translate> | <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
"Hooks": {
"UserToggles": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserToggles"
}
}
|
| <translate> Called from:</translate> | <translate> File(s):</translate> User.php |
| <translate> Interface:</translate> | UserTogglesHook.php |
<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks</tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:UserToggles extensions</tvar>.</translate>
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.
