Add some developer doc for check_account_password hook

This commit is contained in:
Harald Eilertsen
2024-01-21 17:43:35 +01:00
parent d489a2854e
commit 8cd9fff26a

View File

@@ -1 +1,17 @@
[h2]check_account_password[/h2]
Use this hook to provide additional checks or validations of the password given when
registering and account.
[h3]Arguments:[/h3]
[code=php]array(
'password' => $password, // The password to check
'result' => array(
'error' => false,
'message' => ''
)
)[/code]
[h3]Results:[/h3]
For a failed check set the [code]error[/code] member of the [code]result[/code]
array to [code]true[/code] and the [code]message[/code] to a short message
explaining why it failed.
Otherwise, leave it alone.