MediaWiki\Hook\PreferencesGetLegendHook Interface Reference

This is a hook handler interface, see docs/Hooks.md. 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.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 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	$form	the HTMLForm object. This is a ContextSource as well
string	$key	the section name
string	&$legend	the 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:

• includes/specials/Hook/PreferencesGetLegendHook.php