make legal_webbie() pluggable - * this should not be merged with federated projects unless the federation drivers make use of the hooks.

This commit is contained in:
zotlabs
2017-04-05 19:08:43 -07:00
parent 6710a77c26
commit 9fb08fb502
4 changed files with 45 additions and 18 deletions

10
doc/hook/legal_webbie.bb Normal file
View File

@@ -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'.

View File

@@ -0,0 +1,7 @@
[h2]legal_webbie_text[/h2]
Returns a string describing the text rules applied to legal_webbie().
Called with an array [ 'text' => (descriptive text describing text character limitations) ]
A plugin should return the description of the allowed characters and operation performed in the 'legal_webbie' hook to assist people when creating a new channel.

View File

@@ -317,6 +317,12 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/jot_tool]jot_tool[/zrl]
Deprecated and possibly obsolete. Allows one to add action buttons to the post editor.
[zrl=[baseurl]/help/hook/legal_webbie]legal_webbie[/zrl]
Called to validate a channel address
[zrl=[baseurl]/help/hook/legal_webbie_text]legal_webbie_text[/zrl]
Provides an explanation of text/character restrictions for legal_webbie()
[zrl=[baseurl]/help/hook/load_pdl]load_pdl[/zrl]
Called when we load a PDL file or description