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: In extension.json:
	"Hooks": {
		"UserToggles": "MediaWiki\\Extension\\MyExtension\\Hooks::onUserToggles"
Called from: File(s): User.php
Interface: UserTogglesHook.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 UserToggles hook.

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.

See also edit