aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Eilertsen <haraldei@anduin.net>2024-01-21 17:43:35 +0100
committerHarald Eilertsen <haraldei@anduin.net>2024-01-21 17:43:35 +0100
commit8cd9fff26a8789015b3da2b249b37f5c184d5099 (patch)
tree8657732ec5acaa2c6f6b6b1bc8094e5b3731a561
parentd489a2854ea9de4637b0b7f106f00d20efb78e0f (diff)
downloadvolse-hubzilla-8cd9fff26a8789015b3da2b249b37f5c184d5099.tar.gz
volse-hubzilla-8cd9fff26a8789015b3da2b249b37f5c184d5099.tar.bz2
volse-hubzilla-8cd9fff26a8789015b3da2b249b37f5c184d5099.zip
Add some developer doc for check_account_password hook
-rw-r--r--doc/hook/check_account_password.bb16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/hook/check_account_password.bb b/doc/hook/check_account_password.bb
index 53562ec6e..ce5202f48 100644
--- a/doc/hook/check_account_password.bb
+++ b/doc/hook/check_account_password.bb
@@ -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.