MediaWiki  master
MediaWiki\Preferences\Hook\PreferencesFormPreSaveHook Interface Reference

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

Inheritance diagram for MediaWiki\Preferences\Hook\PreferencesFormPreSaveHook:

Public Member Functions

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

Detailed Description

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

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

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$formDataArray of user submitted data
HTMLForm$formHTMLForm object, also a ContextSource
User$userUser with preferences to be saved
bool&$resultBoolean indicating success
array$oldUserOptionsArray 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: