MediaWiki\User\Hook\SpecialPasswordResetOnSubmitHook Interface Reference
This is a hook handler interface, see docs/Hooks.md. More...
Inheritance diagram for MediaWiki\User\Hook\SpecialPasswordResetOnSubmitHook:
Public Member Functions | |
| onSpecialPasswordResetOnSubmit (&$users, $data, &$error) | |
| This hook is called when executing a form submission on Special:PasswordReset. | |
Detailed Description
This is a hook handler interface, see docs/Hooks.md.
Use the hook name "SpecialPasswordResetOnSubmit" to register handlers implementing this interface.
- Stability: stable
- to implement
Definition at line 15 of file SpecialPasswordResetOnSubmitHook.php.
Member Function Documentation
◆ onSpecialPasswordResetOnSubmit()
| MediaWiki\User\Hook\SpecialPasswordResetOnSubmitHook::onSpecialPasswordResetOnSubmit | ( | & | $users, |
| $data, | |||
| & | $error ) |
This hook is called when executing a form submission on Special:PasswordReset.
- Since
- 1.35
- Parameters
-
User[] &$users array $data Array of data submitted by the user string | array | MessageSpecifier &$error String, error code (message key) used to describe to error (out parameter). The hook needs to return false when setting this, otherwise it will have no effect.
- 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/user/Hook/SpecialPasswordResetOnSubmitHook.php
