MediaWiki  master
MediaWiki\Hook\PreferencesGetLegendHook Interface Reference

Stable to implement. More...

Inheritance diagram for MediaWiki\Hook\PreferencesGetLegendHook:

Public Member Functions

 onPreferencesGetLegend ( $form, $key, &$legend)
 Use the hook to override the text used for the <legend> of a preferences section. More...
 

Detailed Description

Stable to implement.

Definition at line 11 of file PreferencesGetLegendHook.php.

Member Function Documentation

◆ onPreferencesGetLegend()

MediaWiki\Hook\PreferencesGetLegendHook::onPreferencesGetLegend (   $form,
  $key,
$legend 
)

Use the hook to override the text used for the <legend> of a preferences section.

Since
1.35
Parameters
HTMLForm$formthe HTMLForm object. This is a ContextSource as well
string$keythe section name
string&$legendthe legend text. Defaults to wfMessage( "prefs-$key" )->text() but may be overridden
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: