vBulletin LTS

[How to] Add new/custom hook locations

by Brad 09 Jun 2005

This guide will teach you how to add your own hook locations to your scripts/default vBulletin source code. Note that I assume that you are working within the vBulletin.php files or you have included vBulletin's global.php.

Adding custom hook locations -

Method one:

See paul's thread here for the best method, if you are going to release your modification to the public this is the way you should go:

index.php?t=83390

Method two:

All hooks listed in this drop down live in the .xml file located at /vbroot/includes/xml/hooks_vbulletin.xml

Find this bit of code at the very top of the file:

HTML Code:

<hooks>
	<hooktype type="admindata">
		<hook>admindata_start</hook>
		<hook>admindata_presave</hook>
		<hook>admindata_postsave</hook>
		<hook>admindata_delete</hook>
	</hooktype>

Looks simple eh? Heres what these tags do

<hooks> - anything between this tag and </hooks> will be included in the drop down

<hooktype type="name"> - The name of your hook group, you should group all common hooks under a group so you can find them quickly. Make sure you don't use a name already used by a default hooktype.

<hook> - The name of your hook, this must be the same as the hook's name in the php code

Here is an example of my .xml file, I added three custom hooks under a new hooktype:

HTML Code:

<hooks>
	<hooktype type="loo_custom">
		<hook>loo_custom1</hook>
		<hook>loo_custom2</hook>
		<hook>loo_custom3</hook>
	</hooktype>

The php code:

Adding a hook location to the php code is easy, just make sure you use the correct hook name! Use this bit of php anywhere after your call to global.php to call your custom hook. Also note that you must use the $hook var!

PHP Code:


($hook = vBulletinHook::fetch_hook('hook_name')) ? eval($hook) : false;

Here is an example of my custom hooks working in vBulletin's index.php file:

PHP Code:


// #######################################################################

// ######################## START MAIN SCRIPT ############################

// #######################################################################



($hook = vBulletinHook::fetch_hook('forumhome_start')) ? eval($hook) : false;

($hook = vBulletinHook::fetch_hook('loo_custom1')) ? eval($hook) : false;

($hook = vBulletinHook::fetch_hook('loo_custom2')) ? eval($hook) : false;

($hook = vBulletinHook::fetch_hook('loo_custom3')) ? eval($hook) : false;

As you can see I added them right under a current hook, which mostly defeats the purpose of making custom hooks. But for this post they serve their purpose

Now all you need to do is browse to your admincp's add new plug-in page and test your new hook location! I use this just to make sure it is working correctly:

PHP Code:


echo('Testing hook_name hook');

If that outputs its text above the vBulletin header then you are good to go!.

vblts.ru supports vBulletin®, 2022-2024