aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/legal_webbie.bb
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hook/legal_webbie.bb')
-rw-r--r--doc/hook/legal_webbie.bb10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/hook/legal_webbie.bb b/doc/hook/legal_webbie.bb
new file mode 100644
index 000000000..8c7d32d56
--- /dev/null
+++ b/doc/hook/legal_webbie.bb
@@ -0,0 +1,10 @@
+[h2]legal_webbie[/h2]
+
+Called when validating a channel address. By default the valid characters are
+a-z,0-9,-,_, and . Uppercase ASCII characters are folded to lower and any invalid characters are stripped.
+
+Some federated networks require more restrictive rules.
+
+The hook is called with an array [ 'input' => (supplied text), 'output' => (validated text) ]
+
+A plugin will generally perform a regex filter or text operation on 'input' and provide the results in 'output'. \ No newline at end of file