MediaWiki master
MediaWiki\Hook\PreferencesGetIconHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions

 onPreferencesGetIcon (&$iconNames)
 Use the hook to add an icon that will be displayed in the mobile layout of Special:Preferences.
 

Detailed Description

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

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

Stability: stable
to implement

Definition at line 12 of file PreferencesGetIconHook.php.

Member Function Documentation

◆ onPreferencesGetIcon()

MediaWiki\Hook\PreferencesGetIconHook::onPreferencesGetIcon ( & $iconNames)

Use the hook to add an icon that will be displayed in the mobile layout of Special:Preferences.

Since
1.40
Parameters
array&$iconNamesa key-value array that assigns an icon name to a section name. The key is the section name, the value is the icon name. You can obtain the icon names from https://doc.wikimedia.org/oojs-ui/master/demos/?page=icons&theme=wikimediaui&direction=ltr&platform=desktop
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: