Hooks

Note: This page is autogenerated every time 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.

analytics

• action:analytics.increment

emailer

• filter:email.prepare

• filter:email.cancel

• filter:email.params

• filter:email.modify

• filter:email.send

• static:email.send

events

• action:events.log

flags

• filter:flags.getFilters

• filter:flags.get

• filter:flags.getFlagIdsWithFilters

• filter:flags.list

• action:flags.create

• action:flags.addReport

• action:flags.update

• filter:parse.raw

• filter:parse.raw

• action:flags.notify

image

• filter:image.isFileTypeAllowed

• filter:image.resize

• filter:image.normalise

• filter:image.size

• filter:image.stripEXIF

• filter:uploadImage

languages

• filter:languages.get

notifications

• filter:user.notificationTypes

• filter:notifications.create

• filter:notification.push

• action:notification.pushed

• filter:notifications.merge

search

• filter:search.query

• filter:search.inContent

• filter:search.contentGetResult

• filter:search.filterAndSort

sitemap

• filter:sitemap.getPages

social

• filter:social.posts

webserver

• action:nodebb.ready

• static:assets.prepare

• static:app.preload

widgets/admin

• filter:widgets.getAreas

• filter:widgets.getWidgets

widgets/index

• filter:widget.render:$[widget.widget]

• filter:widgets.getAreas

user/admin

• filter:user.csvFields

• filter:user.csvFields

user/approval

• filter:user.addToApprovalQueue

• filter:register.complete

• filter:user.getRegistrationQueue

user/blocks

• action:user.blocks.add

• action:user.blocks.remove

• filter:user.blocks.filter

user/categories

• filter:user.getIgnoredCategories

• filter:user.getWatchedCategories

user/create

• filter:user.create

• action:user.create

user/data

• filter:user.whitelistFields

• filter:user.getFields

• filter:users.get

• filter:user.iconBackgrounds

• action:user.set

• action:user.set

user/delete

• static:user.delete

user/digest

• filter:digest.subscribers

user/email

• filter:user.verify

• filter:user.verify.code

• action:user.verify

• action:user.email.confirmed

user/follow

• filter:user.$[type]

user/index

• filter:users.addFields

• filter:userlist.get

user/interstitials

• filter:user.saveEmail

• filter:user.saveEmail

• filter:parse.post

user/invite

• action:user.invite

user/notifications

• filter:user.notifications.get

• filter:user.notifications.getNotifications

• filter:user.notifications.getCount

user/online

• action:user.online

user/profile

• filter:user.updateProfile

• action:user.updateProfile

• filter:username.check

• action:password.change

user/search

• filter:users.search

user/settings

• filter:user.getSettings

• action:user.saveSettings

• filter:user.saveSettings

topics/create

• filter:topic.create

• action:topic.save

• filter:topic.post

• action:topic.post

• filter:topic.reply

• action:topic.reply

topics/data

• filter:topic.getFields

topics/delete

• action:topic.purge

topics/events

• filter:topicEvents.init

• filter:topic.events.log

topics/fork

• filter:topic.fork

• action:topic.fork

• action:post.move

topics/index

• filter:topics.get

• filter:topic.thread_tools

• filter:topic.get

• filter:topic.search

topics/merge

• action:topic.merge

• filter:topic.mergeCreateNewTopic

topics/posts

• filter:topic.getPosts

• filter:topics.addPostData

• filter:topics.getPostReplies

topics/recent

• filter:topics.updateRecent

topics/sorted

• filter:topics.getSortedTids

• filter:topics.filterSortedTids

topics/tags

• filter:tags.filter

• filter:topics.getTagTids

• filter:topics.getTagTidsByCids

• filter:topics.getTagTopicCount

• filter:tags.getAll

• filter:topics.searchTags

• filter:tags.search

• filter:topics.autocompleteTags

• filter:topic.getRelatedTopics

topics/teaser

• filter:teasers.configureStripTags

• filter:teasers.get

topics/thumbs

• filter:topics.getThumbs

topics/unread

• filter:topics.unreadCutoff

• filter:topics.getUnreadTids

• filter:topics.unread.getCategoryTids

• action:topics.markAsRead

topics/tools

• filter:topic.$[hook]

• action:topic.delete

• action:topic.restore

• action:topic.lock

• action:topic.setPinExpiry

• action:topic.pin

• action:topic.move

socket.io/helpers

• filter:sockets.sendNewPostToUids

socket.io/index

• action:sockets.disconnect

• action:sockets.connect

• filter:sockets.sessionId

• static:sockets.validateSession

• filter:sockets.sessionId

socket.io/posts

• filter:post.getRawPost

• filter:parse.post

socket.io/user

• action:password.reset

socket.io/user/picture

• action:user.removeUploadedPicture

• filter:user.listPictures

socket.io/user/profile

• action:user.removeCoverPicture

socket.io/topics/tools

• filter:topic.thread_tools

socket.io/posts/tools

• filter:post.tools

socket.io/categories/search

• filter:categories.categorySearch

socket.io/admin/cache

• filter:admin.cache.get

• filter:admin.cache.get

socket.io/admin/config

• action:config.set

routes/authentication

• action:auth.overrideLogin

• filter:auth.init

• filter:auth.options

routes/index

• filter:router.add

routes/write/index

• static:api.routes

rewards/admin

• filter:rewards.conditions

• filter:rewards.conditionals

• filter:rewards.rewards

rewards/index

• filter:rewards.checkConditional:$[reward.conditional]

privileges/admin

• filter:privileges.admin.list

• filter:privileges.admin.groups.list

• static:privileges.admin.init

• filter:privileges.admin.list_human

• filter:privileges.admin.groups.list_human

• filter:privileges.admin.get

• action:privileges.admin.give

• action:privileges.admin.rescind

privileges/categories

• filter:privileges.list

• filter:privileges.groups.list

• static:privileges.categories.init

• filter:privileges.list_human

• filter:privileges.groups.list_human

• filter:privileges.categories.get

• action:privileges.categories.give

• action:privileges.categories.rescind

privileges/global

• filter:privileges.global.list

• filter:privileges.global.groups.list

• static:privileges.global.init

• filter:privileges.global.list_human

• filter:privileges.global.groups.list_human

• filter:privileges.global.get

• action:privileges.global.give

• action:privileges.global.rescind

privileges/helpers

• filter:privileges:isUsersAllowedTo

• filter:privileges:isAllowedTo

privileges/posts

• filter:privileges.posts.filter

• filter:privileges.posts.edit

privileges/topics

• filter:privileges.topics.get

• filter:privileges.topics.filter

privileges/users

• filter:user.isModerator

• filter:user.canEdit

• filter:user.canBanUser

• filter:user.canMuteUser

• filter:user.has$[privilegeName]Privilege

posts/bookmarks

• action:post.$[type]

posts/create

• filter:post.create

• filter:post.get

• action:post.save

posts/data

• filter:post.getFields

• action:post.setFields

posts/delete

• filter:post.$[type]

• action:post.$[type]

• filter:post.purge

• filter:posts.purge

• action:post.purge

• action:posts.purge

posts/diffs

• filter:parse.post

posts/edit

• filter:post.edit

• action:post.edit

• filter:topic.edit

• action:topic.edit

posts/index

• filter:post.getPosts

posts/parse

• filter:parse.post

• filter:parse.signature

• filter:sanitize.config

posts/queue

• filter:parse.post

• filter:post.shouldQueue

• filter:parse.raw

posts/summary

• filter:post.getPostSummaryByPids

posts/user

• filter:posts.custom_profile_info

• filter:posts.modifyUserInfo

• filter:posts.getUserInfoForPosts

• filter:posts.addUserFields

• action:post.changeOwner

• action:topic.changeOwner

posts/votes

• action:post.$[hook]

• action:post.updatePostVoteCount

plugins/hooks

• filter:plugins.firehook

• action:plugins.firehook

plugins/index

• static:app.load

plugins/install

• action:plugin.$[hook]

• action:plugin.$[type]

navigation/admin

• filter:navigation.available

middleware/admin

• filter:admin.header.build

• filter:middleware.renderAdminHeader

• filter:admin.scripts.get

middleware/headers

• filter:middleware.autoLocale

middleware/header

• filter:middleware.buildHeader

• filter:middleware.renderHeader

• filter:middleware.renderFooter

• filter:scripts.get

middleware/index

• action:middleware.pageView

• static:auth.validate

middleware/render

• filter:$[template].build

• filter:middleware.render

middleware/user

• filter:middleware.authenticate

• filter:middleware.registrationComplete

meta/blacklist

• filter:blacklist.test

meta/tags

• filter:meta.getMetaTags

• filter:meta.getLinkTags

• filter:meta.addSiteOGImage

meta/settings

• filter:settings.get

• filter:settings.set

• action:settings.set

messaging/data

• filter:messaging.getMessages

• filter:messaging.getFields

messaging/create

• filter:messaging.checkContent

• filter:messaging.save

• action:messaging.save

messaging/notifications

• filter:messaging.notify

messaging/index

• filter:parse.raw

• filter:messaging.parse

• filter:messaging.getRecentChats

• filter:messaging.getTeaser

• static:messaging.canMessageUser

• static:messaging.canMessageRoom

messaging/edit

• filter:messaging.edit

messaging/rooms

• filter:messaging.isUserInRoom

• filter:messaging.isRoomOwner

• filter:messaging.addUsersToRoom

• filter:messaging.removeUsersFromRoom

• filter:chat.renameRoom

• action:chat.renameRoom

• filter:messaging.canReply

• filter:messaging.loadRoom

groups/create

• filter:group.create

• action:group.create

groups/data

• filter:groups.get

• action:group.set

groups/delete

• action:groups.destroy

groups/index

• filter:parse.raw

• filter:group.get

• filter:group.getOwnersAndMembers

groups/invite

• action:group.$[hookName]

groups/join

• action:group.join

groups/leave

• action:group.leave

groups/ownership

• action:group.grantOwnership

• action:group.rescindOwnership

groups/update

• filter:group.update

• action:group.update

• action:group.rename

controllers/404

• action:meta.override404

controllers/api

• filter:config.get

controllers/authentication

• filter:register.interstitial

• filter:register.shouldQueue

• filter:register.complete

• filter:register.check

• filter:register.interstitial

• filter:login.override

• filter:login.check

• action:login.continue

• action:login.continue

• action:login.continue

• action:user.loggedIn

• static:user.loggedOut

• filter:user.logout

controllers/errors

• filter:error.handle

controllers/composer

• filter:composer.build

controllers/helpers

• filter:helpers.notAllowed

• filter:helpers.getVisibleCategories

• filter:homepage.get

controllers/index

• filter:register.interstitial

• filter:manifest.build

• filter:parse.post

controllers/mods

• filter:flags.validateFilters

• filter:flags.validateSort

controllers/uploads

• filter:uploadImage

• filter:uploadImage

• filter:uploadFile

• filter:uploadStored

controllers/admin/cache

• filter:admin.cache.get

• filter:admin.cache.get

controllers/admin/categories

• filter:admin.category.get

• filter:admin.categories.get

controllers/admin/dashboard

• filter:admin.notices

• filter:admin.getStats

controllers/admin/uploads

• filter:uploadImage

controllers/admin/users

• filter:admin.registrationQueue.customHeaders

controllers/accounts/blocks

• filter:user.getBlocks

controllers/accounts/helpers

• filter:helpers.getUserDataByUserSlug

• filter:auth.list

• filter:user.profileMenu

• filter:parse.aboutme

controllers/accounts/notifications

• filter:notifications.addFilters

controllers/accounts/posts

• filter:account.getPostsFromUserSet

controllers/accounts/profile

• filter:account.profile.getPids

controllers/accounts/settings

• filter:user.customSettings

• filter:user.notificationTypes

categories/data

• filter:category.getFields

categories/create

• filter:category.create

• action:category.create

• filter:categories.copySettingsFrom

• filter:categories.copyPrivilegesFrom

categories/delete

• action:category.delete

categories/search

• filter:categories.search

categories/recentreplies

• action:categories.updateRecentTid

• filter:categories.getRecentTopicReplies

categories/index

• filter:category.get

categories/topics

• filter:category.topics.prepare

• filter:category.topics.get

• filter:categories.getTopicIds

• filter:categories.getTopicCount

• filter:categories.buildTopicsSortedSet

• filter:categories.getSortedSetRangeDirection

• filter:categories.getPinnedTids

categories/update

• filter:category.update

• action:category.update

• filter:parse.raw

api/chats

• filter:messaging.send

api/helpers

• filter:post.$[command]

api/users

• action:user.follow

• action:user.unfollow

• action:user.banned

• action:user.unbanned

• action:user.muted

• action:user.unmuted

• action:user.delete

• filter:user.getPicture

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
});

app

• action:app.load

• action:composer.topic.new

ajaxify

• action:ajaxify.end

• action:ajaxify.coldLoad

• action:ajaxify.start

• action:ajaxify.loadingTemplates

• action:ajaxify.updateTitle

• action:ajaxify.end

• action:ajaxify.contentLoaded

• action:script.load

• filter:script.load

• static:script.init

• action:ajaxify.loadingData

• action:ajaxify.dataLoaded

• action:popstate

sockets

• action:connected

• action:reconnected

• action:disconnected

widgets

• action:widgets.loaded

modules/alerts

• action:alert.new

• action:alert.update

• action:alert.animate

modules/api

• filter:api.options

modules/categoryFilter

• action:category.filter.options

modules/categorySelector

• action:category.selector.options

modules/chat

• action:chat.renamed

• action:chat.loaded

• action:chat.closed

• action:chat.minimized

modules/flags

• action:flag.showModal

• action:flag.resolved

• action:flag.create

modules/logout

• action:app.logout

• action:app.loggedOut

modules/notifications

• filter:notifications.load

• action:notifications.loaded

• action:notification.updateCount

modules/search

• action:search.submit

• action:search.quick.start

• action:search.quick.complete

• action:search.createQueryString

modules/settings

• action:admin.settingsLoaded

modules/share

• action:share.open

• action:share.addHandlers

modules/taskbar

• filter:taskbar.push

• action:taskbar.toggleNew

• action:taskbar.pushed

modules/topicList

• action:topics.loaded

• filter:topicList.onNewTopic

• filter:topicList.onNewPost

• action:topics.loading

• action:topics.loaded

modules/translator

• action:translator.loadClient

client/categories

• action:posts.loaded

client/category

• action:topics.loaded

• action:category.loaded

• action:topics.loading

• action:topics.loaded

client/chats

• action:chat.loaded

• action:chat.loaded

client/compose

• action:composer.enhance

client/infinitescroll

• action:infinitescroll.loadmore

• action:infinitescroll.loadmore.xhr

client/login

• action:app.login

• action:app.loggedIn

client/search

• action:search.getSearchDataFromDOM

• action:search.fillOutForm

client/topic

• action:topic.loading

• action:topic.loaded

client/topic/events

• action:posts.edited

• action:posts.edited

client/topic/move

• action:topic.move

client/topic/postTools

• action:post.tools.load

• action:composer.topic.new

• action:composer.post.edit

• action:composer.addQuote

• action:composer.post.new

• action:composer.addQuote

• action:post.$[type]

• static:post.$[action]

• action:composer.topic.new

client/topic/posts

• action:posts.loading

• action:posts.loaded

client/topic/replies

• action:posts.loaded

client/topic/threadTools

• action:topics.changeWatching

• action:topic.tools.load

client/topic/votes

• action:post.toggleVote

client/chats/messages

• action:chat.sent

• filter:chat.send

• action:chat.updateRemainingLength

• action:chat.received

• action:chat.prepEdit

client/account/blocks

• action:user.blocks.toggle

client/account/edit

• action:profile.update

client/account/posts

• action:posts.loaded

client/account/topics

• action:topics.loaded

admin/settings

• action:admin.settingsSaved

• action:admin.settingsLoaded

admin/modules/dashboard-line-graph

• action:admin.dashboard.updateGraph

This page was generated on Fri, 02 Sep 2022 19:14:20 GMT Total Hooks: 469