Manual:Hooks/SpecialPasswordResetOnSubmit
From Linux Web Expert
| SpecialPasswordResetOnSubmit | |
|---|---|
| <translate> Available from <tvar name=1><translate> version <tvar (r86482, codereview)</tvar></translate> Called when executing a form submission on Special:PasswordReset. | |
| <translate> Define function:</translate> | public static function onSpecialPasswordResetOnSubmit( $users, $data, &$error ) { ... }
|
| <translate> Attach hook:</translate> | <translate> In <tvar name=1>extension.json</tvar>:</translate>
{
"Hooks": {
"SpecialPasswordResetOnSubmit": "MediaWiki\\Extension\\MyExtension\\Hooks::onSpecialPasswordResetOnSubmit"
}
}
|
| <translate> Called from:</translate> | <translate> File(s):</translate> SpecialPasswordReset.php |
| <translate> Interface:</translate> | SpecialPasswordResetOnSubmitHook.php |
<translate> For more information about attaching hooks, see <tvar name=1>Manual:Hooks</tvar>.</translate>
<translate> For examples of extensions using this hook, see <tvar name=cat>Category:SpecialPasswordResetOnSubmit extensions</tvar>.</translate>
Details
- $users: array of User objects
- $data: array of data submitted by the user
- &$error: string, error code (message name) used to describe to error (out parameter). The hook needs to return false when setting this, otherwise it will have no effect.
