MediaWiki\Preferences\Hook\PreferencesFormPreSaveHook Interface Reference

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

Inherited by MediaWiki\HookContainer\HookRunner.

Public Member Functions
	onPreferencesFormPreSave ( $formData, $form, $user, &$result, $oldUserOptions)
	Use this hook to override preferences being saved.

Detailed Description

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

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

Stability: stable

to implement

Definition at line 15 of file PreferencesFormPreSaveHook.php.

Member Function Documentation

onPreferencesFormPreSave()

MediaWiki\Preferences\Hook\PreferencesFormPreSaveHook::onPreferencesFormPreSave	(		$formData,
			$form,
			$user,
		&	$result,
			$oldUserOptions )

Use this hook to override preferences being saved.

Since

1.35

Parameters

array	$formData	Array of user submitted data
HTMLForm	$form	HTMLForm object, also a ContextSource
User	$user	User with preferences to be saved
bool	&$result	Boolean indicating success
array	$oldUserOptions	Array with user's old options (before save)

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/PreferencesFormPreSaveHook.php