Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-11-07 22:45:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

wrapped up hooks section

Browse Source
This commit is contained in:
psychobunny
2014-04-26 17:06:21 -04:00
parent 8bb225d8c0
commit f3cc98b2c0
1 changed files with 46 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
docs/plugins/hooks.rst
View File

@@ -1,11 +1,11 @@
List of Hooks
Available Hooks
=============
The following is a list of all hooks present in NodeBB. This list is intended to guide developers who are looking to write plugins for NodeBB. For more information, please consult [[Writing Plugins for NodeBB]].
There are two types of hooks, **filters**, and **actions**. Filters take an input (provided as a single argument), parse it in some way, and return the changed value. Actions take multiple inputs, and execute actions based on the inputs received. Actions do not return anything.
**Important**: This list is by no means exhaustive. Hooks are added on an as-needed basis (or if we can see a potential use case ahead of time), and all requests to add new hooks to NodeBB should be sent to us via the [issue tracker](https://github.com/designcreateplay/NodeBB/issues).
**Important**: This list is by no means exhaustive. Hooks are added on an as-needed basis (or if we can see a potential use case ahead of time), and all requests to add new hooks to NodeBB should be sent to us via the `issue tracker <https://github.com/designcreateplay/NodeBB/issues>`_.
Filters
@@ -16,98 +16,93 @@ Filters
Allows plugins to create new navigation links in the ACP
`filter:post.save`
``filter:post.save``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: A post's content (markdown text)
Executed whenever a post is created or edited, but before it is saved into the database.
`filter:post.get`
``filter:post.get``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: A post object (javascript Object)
Executed whenever a post is retrieved, but before being sent to the client.
`filter:header.build`
``filter:header.build``
^^^^^^^^^^^^^^^^^^^^^
**Allows plugins to add new navigation links to NodeBB**
[View commit for more details](https://github.com/designcreateplay/NodeBB/commit/a63732027f9ba0bd54254c3b5c83f2a63f1ad531)
`filter:post.parse`
``filter:post.parse``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: A post or signature's raw text (String)
Executed when a post or signature needs to be parsed from raw text to HTML (for output to client). This is useful if you'd like to use a parser to prettify posts, such as [Markdown](http://daringfireball.net/projects/markdown/), or [BBCode](http://www.bbcode.org/).
Executed when a post or signature needs to be parsed from raw text to HTML (for output to client). This is useful if you'd like to use a parser to prettify posts, such as `Markdown <http://daringfireball.net/projects/markdown/>`_, or `BBCode <http://www.bbcode.org/>`_.
`filter:posts.custom_profile_info`
``filter:posts.custom_profile_info``
^^^^^^^^^^^^^^^^^^^^^
**Allows plugins to add custom profile information in the topic view's author post block**
[View commit for more details](https://github.com/designcreateplay/NodeBB/commit/bf677522a93ec4c48f6b0fa27ab1388f9eedba4c)
`filter:register.check`
``filter:register.check``
^^^^^^^^^^^^^^^^^^^^^
**Allows plugins to run checks on information and deny registration if necessary.**
[View commit for more details](https://github.com/designcreateplay/NodeBB/commit/cd4a204f999d5ef5bac4557f03d4c15abebfdce3)
`filter:scripts.get`
``filter:scripts.get``
^^^^^^^^^^^^^^^^^^^^^
**Allows to add client-side JS to the header and queue up for minification on production**
[View commit for more details](https://github.com/designcreateplay/NodeBB/commit/5357ad61db6c15bc25a7e836548a02fadd72e6b3)
`filter:uploadImage`
``filter:uploadImage``
^^^^^^^^^^^^^^^^^^^^^
`filter:uploadFile`
``filter:uploadFile``
^^^^^^^^^^^^^^^^^^^^^
`filter:widgets.getAreas`
``filter:widgets.getAreas``
^^^^^^^^^^^^^^^^^^^^^
`filter:widgets.getWidgets`
``filter:widgets.getWidgets``
^^^^^^^^^^^^^^^^^^^^^
`filter:search.query`
``filter:search.query``
^^^^^^^^^^^^^^^^^^^^^
`filter:post.parse`
``filter:post.parse``
^^^^^^^^^^^^^^^^^^^^^
`filter:messaging.parse`
``filter:messaging.parse``
^^^^^^^^^^^^^^^^^^^^^
`filter:sounds.get`
``filter:sounds.get``
^^^^^^^^^^^^^^^^^^^^^
`filter:post.getPosts`
``filter:post.getPosts``
^^^^^^^^^^^^^^^^^^^^^
`filter:post.getFields`
``filter:post.getFields``
^^^^^^^^^^^^^^^^^^^^^
`filter:auth.init`
``filter:auth.init``
^^^^^^^^^^^^^^^^^^^^^
`filter:composer.help`
``filter:composer.help``
^^^^^^^^^^^^^^^^^^^^^
`filter:topic.thread_tools`
``filter:topic.thread_tools``
^^^^^^^^^^^^^^^^^^^^^
`filter:user.create`
``filter:user.create``
^^^^^^^^^^^^^^^^^^^^^
`filter:widget.render`
``filter:widget.render``
^^^^^^^^^^^^^^^^^^^^^
@@ -115,72 +110,72 @@ Executed when a post or signature needs to be parsed from raw text to HTML (for
Actions
----------
`action:app.load`
``action:app.load``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: None
Executed when NodeBB is loaded, used to kickstart scripts in plugins (i.e. cron jobs, etc)
`action:page.load`
``action:page.load``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: An object containing the following properties:
* `template` - The template loaded
* `url` - Path to the page (relative to the site's base url)
* ``template`` - The template loaded
* ``url`` - Path to the page (relative to the site's base url)
`action:plugin.activate`
``action:plugin.activate``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: A String containing the plugin's `id` (e.g. `nodebb-plugin-markdown`)
**Argument(s)**: A String containing the plugin's ``id`` (e.g. ``nodebb-plugin-markdown``)
Executed whenever a plugin is activated via the admin panel.
**Important**: Be sure to check the `id` that is sent in with this hook, otherwise your plugin will fire its registered hook method, even if your plugin was not the one that was activated.
**Important**: Be sure to check the ``id`` that is sent in with this hook, otherwise your plugin will fire its registered hook method, even if your plugin was not the one that was activated.
`action:plugin.deactivate`
``action:plugin.deactivate``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: A String containing the plugin's `id` (e.g. `nodebb-plugin-markdown`)
**Argument(s)**: A String containing the plugin's ``id`` (e.g. ``nodebb-plugin-markdown``)
Executed whenever a plugin is deactivated via the admin panel.
**Important**: Be sure to check the `id` that is sent in with this hook, otherwise your plugin will fire its registered hook method, even if your plugin was not the one that was deactivated.
**Important**: Be sure to check the ``id`` that is sent in with this hook, otherwise your plugin will fire its registered hook method, even if your plugin was not the one that was deactivated.
`action:post.save`
``action:post.save``
^^^^^^^^^^^^^^^^^^^^^
**Argument(s)**: A post object (javascript Object)
Executed whenever a post is created or edited, after it is saved into the database.
`action:email.send`
``action:email.send``
^^^^^^^^^^^^^^^^^^^^^
`action:post.setField`
``action:post.setField``
^^^^^^^^^^^^^^^^^^^^^
`action:topic.edit`
``action:topic.edit``
^^^^^^^^^^^^^^^^^^^^^
`action:post.edit`
``action:post.edit``
^^^^^^^^^^^^^^^^^^^^^
`action:post.delete`
``action:post.delete``
^^^^^^^^^^^^^^^^^^^^^
`action:post.restore`
``action:post.restore``
^^^^^^^^^^^^^^^^^^^^^
`action:config.set`
``action:config.set``
^^^^^^^^^^^^^^^^^^^^^
`action:topic.save`
``action:topic.save``
^^^^^^^^^^^^^^^^^^^^^
`action:user.create`
``action:user.create``
^^^^^^^^^^^^^^^^^^^^^
`action:topic.delete`
``action:topic.delete``
^^^^^^^^^^^^^^^^^^^^^