aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/hook/probe_well_known.bb2
-rw-r--r--doc/hook/validate_channelname.bb22
2 files changed, 24 insertions, 0 deletions
diff --git a/doc/hook/probe_well_known.bb b/doc/hook/probe_well_known.bb
index eff690f31..62898c536 100644
--- a/doc/hook/probe_well_known.bb
+++ b/doc/hook/probe_well_known.bb
@@ -1 +1,3 @@
[h2]probe_well_known[/h2]
+
+This hook is under construction and not currently used - see include/probe.php \ No newline at end of file
diff --git a/doc/hook/validate_channelname.bb b/doc/hook/validate_channelname.bb
index c78961017..2ab12bbec 100644
--- a/doc/hook/validate_channelname.bb
+++ b/doc/hook/validate_channelname.bb
@@ -1 +1,23 @@
[h2]validate_channelname[/h2]
+
+Called when creating a new channel or changing the channel name in mod/settings.php
+
+Hook data consists of an array
+
+ array(
+ 'name' => supplied name
+ );
+
+ If the hook handler determines the name is valid, do nothing. If there is an issue with the name,
+ set $hook_data['message'] to the message text which should be displayed to the member - and the name will
+ not be accepted.
+
+
+ Example:
+ [code]
+ if(mb_strlen($hook_data['name']) < 3)
+ $hook_data['message'] = t('Name too short.');
+ [/code]
+
+
+ \ No newline at end of file