aboutsummaryrefslogtreecommitdiffstats
path: root/doc/en/hook/check_account_password.bb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/hook/check_account_password.bb')
-rw-r--r--doc/en/hook/check_account_password.bb17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/en/hook/check_account_password.bb b/doc/en/hook/check_account_password.bb
new file mode 100644
index 000000000..ce5202f48
--- /dev/null
+++ b/doc/en/hook/check_account_password.bb
@@ -0,0 +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.