Hooks

Note: This page is autogenerated everytime a new commit occurs in NodeBB. Do not make changes here or you will lose your information

Server Side Hooks

For further information consult our documentation on how to build plugins.

categories

• filter:category.get

• filter:parse.raw

emailer

• action:email.send

favourites

• action:post.*

• action:post.*

groups

• filter:parse.raw

• filter:group.get

• action:group.set

• filter:groups.get

image

• filter:image.resize

• filter:image.normalise

messaging

• filter:messaging.save

• filter:parse.raw

• filter:messaging.parse

notifications

• action:notification.pushed

plugins

• static:app.load

• filter:plugins.clearRequireCache

posts

• filter:post.getPosts

• filter:post.get

• filter:post.getFields

• filter:post.getFields

• action:post.setFields

• action:post.setFields

search

• filter:search.query

threadTools

• action:topic.delete

• action:topic.restore

• action:topic.lock

• action:topic.pin

• action:topic.move

topics

• filter:topics.get

• filter:topic.get

• filter:topic.search

user

• filter:users.get

• action:user.online

• action:user.set

• action:user.set

• action:user.set

• action:user.set

• filter:users.addFields

• filter:userlist.get

• filter:user.isModerator

webserver

• static:app.preload

categories/create

• filter:category.create

• action:category.create

categories/topics

• filter:category.topics.prepare

• filter:category.topics.get

categories/update

• filter:category.update

• action:category.update

controllers/accounts

• filter:user.profileLinks

• filter:parse.raw

• filter:user.account

• filter:user.profileLinks

• filter:user.settings

controllers/admin

• filter:admin.notices

• filter:admin.category.get

• filter:homepage.get

controllers/api

• filter:config.get

controllers/authentication

• filter:register.check

• filter:register.complete

• action:user.loggedIn

• action:user.loggedOut

controllers/categories

• filter:categories.build

• filter:category.build

controllers/index

• filter:parse.post

• filter:register.build

controllers/recent

• filter:recent.build

controllers/search

• filter:search.build

controllers/topics

• filter:controllers.topic.get

• filter:topic.build

controllers/uploads

• filter:uploadImage

• filter:uploadFile

controllers/users

• filter:users.build

meta/js

• filter:scripts.get

meta/settings

• action:settings.set

meta/sounds

• filter:sounds.get

middleware/admin

• filter:admin.scripts.get

• filter:admin.header.build

middleware/middleware

• action:middleware.authenticate

• action:middleware.pageView

• filter:middleware.buildHeader

• filter:middleware.renderHeader

plugins/install

• action:plugin.deactivate

• action:plugin.activate

• action:plugin.*

posts/create

• filter:post.save

• filter:post.get

• action:post.save

posts/delete

• action:post.delete

• action:post.restore

• action:post.purge

posts/edit

• filter:post.edit

• action:post.edit

• action:topic.edit

posts/parse

• filter:parse.post

• filter:parse.signature

posts/summary

• filter:post.getPostSummaryByPids

posts/user

• filter:posts.custom_profile_info

• filter:posts.modifyUserInfo

privileges/categories

• filter:privileges.categories.get

privileges/posts

• filter:privileges.posts.filter

privileges/topics

• filter:privileges.topics.get

• filter:privileges.topics.filter

rewards/admin

• filter:rewards.conditions

• filter:rewards.conditionals

• filter:rewards.rewards

rewards/index

• filter:rewards.checkConditional:*

• action:rewards.award:*

routes/authentication

• action:auth.overrideLogin

• filter:auth.init

routes/index

• action:meta.override404

socket.io/admin

• action:config.set

• action:config.set

socket.io/posts

• filter:sockets.sendNewPostToUids

• filter:post.*

• action:post.flag

socket.io/topics

• filter:sockets.sendNewPostToUids

socket.io/user

• action:user.*

topics/create

• filter:topic.create

• action:topic.save

• filter:topic.post

• action:topic.post

• filter:topic.reply

• action:topic.reply

topics/delete

• action:topic.purge

topics/fork

• action:post.move

topics/tags

• filter:tags.filter

• filter:tags.search

topics/teaser

• filter:teasers.get

user/create

• filter:user.create

• action:user.create

user/delete

• static:user.delete

• filter:user.delete

user/digest

• filter:digest.subscribers

user/email

• filter:user.verify.code

• action:user.verify

user/follow

• filter:user.*

user/picture

• filter:uploadImage

user/profile

• filter:user.updateProfile

• action:user.updateProfile

user/search

• filter:users.search

user/settings

• filter:user.getSettings

• action:user.saveSettings

groups/create

• action:group.create

groups/delete

• action:group.destroy

groups/membership

• action:group.join

• action:group.leave

groups/update

• action:group.update

• action:group.rename

widgets/admin

• filter:widgets.getAreas

• filter:widgets.getWidgets

widgets/index

• filter:widget.render:*

• filter:widgets.getAreas

navigation/admin

• filter:header.build

• filter:navigation.available

controllers/admin/uploads

• filter:uploadImage

socket.io/admin/categories

• filter:admin.categories.get

Client Side Hooks

On the client-facing side, NodeBB fires off events and executes any handlers bound to the window object.

To attach a listener, do the following:

$(window).on('action:ajaxify.end', function(event, data) {
	console.log(data);  // to inspect what is passed back by NodeBB
});

ajaxify

• action:popstate

• action:ajaxify.start

• action:ajaxify.loadingTemplates

• action:ajaxify.end

• action:ajaxify.contentLoaded

• action:ajaxify.loadingData

• action:ajaxify.dataLoaded

app

• action:connected

• action:disconnected

• action:reconnected

• action:composer.topic.new

• action:composer.topic.new

• action:app.load

widgets

• action:widgets.loaded

admin/admin

• action:config.loaded

admin/settings

• action:admin.settingsLoaded

client/categories

• action:posts.loaded

client/category

• filter:categories.new_topic

• action:categories.new_topic.loaded

• action:categories.loading

• action:categories.loaded

client/recent

• action:topics.loaded

client/topic

• action:topic.loading

• action:topic.loaded

modules/chat

• action:chat.loaded

modules/settings

• action:admin.settingsLoaded

modules/taskbar

• filter:taskbar.push

• action:taskbar.toggleNew

• action:taskbar.pushed

client/account/topics

• action:topics.loaded

client/topic/events

• action:posts.edited

client/topic/postTools

• action:composer.post.edit

• action:composer.addQuote

• action:composer.post.new

• action:composer.addQuote

client/topic/posts

• action:posts.loading

• action:posts.loaded

This page was generated on Sun, 06 Sep 2015 04:49:56 GMT Total Hooks: 193