aboutsummaryrefslogtreecommitdiffstats
path: root/doc/hook/validate_channelname.bb
diff options
context:
space:
mode:
authorredmatrix <redmatrix@redmatrix.me>2015-11-09 20:56:37 -0800
committerredmatrix <redmatrix@redmatrix.me>2015-11-09 20:56:37 -0800
commit7ec687988746e1037d86d25186c2dd5f2addb15b (patch)
tree7b494b52f213de9d00a9eb09b478949dcfb059c2 /doc/hook/validate_channelname.bb
parentc4a3487f0cee6391419fd73f2f89f074731a064c (diff)
downloadvolse-hubzilla-7ec687988746e1037d86d25186c2dd5f2addb15b.tar.gz
volse-hubzilla-7ec687988746e1037d86d25186c2dd5f2addb15b.tar.bz2
volse-hubzilla-7ec687988746e1037d86d25186c2dd5f2addb15b.zip
more doco
Diffstat (limited to 'doc/hook/validate_channelname.bb')
-rw-r--r--doc/hook/validate_channelname.bb22
1 files changed, 22 insertions, 0 deletions
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