diff options
| author | zotlabs <mike@macgirvin.com> | 2017-04-05 19:08:43 -0700 |
|---|---|---|
| committer | zotlabs <mike@macgirvin.com> | 2017-04-05 19:08:43 -0700 |
| commit | 9fb08fb5022c9eaf6368a9d3ac07bb1dcf856c20 (patch) | |
| tree | c83aec69b20bcee45b022dd343faa1155835a5c1 /doc | |
| parent | 6710a77c26b9f5d621ad839cadeefb08fa066aa2 (diff) | |
| download | volse-hubzilla-9fb08fb5022c9eaf6368a9d3ac07bb1dcf856c20.tar.gz volse-hubzilla-9fb08fb5022c9eaf6368a9d3ac07bb1dcf856c20.tar.bz2 volse-hubzilla-9fb08fb5022c9eaf6368a9d3ac07bb1dcf856c20.zip | |
make legal_webbie() pluggable - * this should not be merged with federated projects unless the federation drivers make use of the hooks.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/hook/legal_webbie.bb | 10 | ||||
| -rw-r--r-- | doc/hook/legal_webbie_text.bb | 7 | ||||
| -rw-r--r-- | doc/hooklist.bb | 6 |
3 files changed, 23 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 diff --git a/doc/hook/legal_webbie_text.bb b/doc/hook/legal_webbie_text.bb new file mode 100644 index 000000000..32c74c93b --- /dev/null +++ b/doc/hook/legal_webbie_text.bb @@ -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.
\ No newline at end of file diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 6933edad2..0b74a4df2 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -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 |