1	<?php
2
3	namespace MediaWiki\User\Hook;
4
5	use MediaWiki\User\User;
6	use MessageSpecifier;
7
8	/**
9	* This is a hook handler interface, see docs/Hooks.md.
10	* Use the hook name "SpecialPasswordResetOnSubmit" to register handlers implementing this interface.
11	*
12	* @stable to implement
13	* @ingroup Hooks
14	*/
15	interface SpecialPasswordResetOnSubmitHook {
16	/**
17	* This hook is called when executing a form submission on Special:PasswordReset.
18	*
19	* @since 1.35
20	*
21	* @param User[] &$users
22	* @param array $data Array of data submitted by the user
23	* @param string|array|MessageSpecifier &$error String, error code (message key)
24	*   used to describe to error (out parameter). The hook needs to return false
25	*   when setting this, otherwise it will have no effect.
26	* @return bool|void True or no return value to continue or false to abort
27	*/
28	public function onSpecialPasswordResetOnSubmit( &$users, $data, &$error );
29	}