MediaWiki\Preferences\Hook\GetPreferencesHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onGetPreferences ( $user, &$preferences)
	Use this hook to modify user preferences.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 14 of file GetPreferencesHook.php.

Member Function Documentation

onGetPreferences()

MediaWiki\Preferences\Hook\GetPreferencesHook::onGetPreferences	(		$user,
		&	$preferences )

Use this hook to modify user preferences.

Since

1.35

Parameters

User	$user	User whose preferences are being modified
array	&$preferences	Preferences description array, to be fed to an HTMLForm object

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/Preferences/Hook/GetPreferencesHook.php