Hooks & Filters Docu
-
Rather than just keeping private notes on the hooks and filters I found, I thought it best to maybe start a list here with everyone, just as a rough working documentation of the hooks and filters.
For future ref/for people that don’t know, a hook is a means of bbPress making your plugin run every time a certain thing happens. To get that to work, put this code at the very bottom of your plugin:
add_action( 'hook_name', 'functionname' );
Filters are very similar to hooks, only it gives your plugin some data, you can then do something with the data (filter it), and then pass it back. To register for filters, put this code at the bottom of your application; remember to accept the parameters in your function and return them as appropriate.
add_filter( 'filter_name', 'functionname' );
Note that in both cases you want the name as a string and the function’s name as a string, no brackets or parameters at the end of it! An optional third parameter is the priority of your function; default is 10, so set this higher if you want it to execute last or lower if you want it to execute earlier.
Some Filters
topic_title
– this passes the topic title to your function when the threads are being listed, like on the (default) front page.bb_allowed_tags
– this is the array of HTML tags you can use in your posts. Hang a filter on this and add elements to the array if you want to allow more tags.Some Hooks
bb_head
– this is called when the HTML<head>
element is being filled, so you can add stylesheets or javascript and the like.bb_user_logout
obviously gets called when someone logs out.bb_init
when someone logs in?bb_new_user
when someone registers; passes the ID along I thinkbb_profile_menu
– haven’t figured out how it works; I think it’s to do with the tabs at the top of the profile.If you know any more hooks or filters, or find ’em, please post them here with a quick description if necessary!
- You must be logged in to reply to this topic.