Jump to content
DevFuse Forums
Sign in to follow this  

Install a hook


Description

Beginners guide to install a hook

A very quick article to help those new to IPBoard on how to install a hook, by their nature they are easy to install. Hopefully this short guide should answer any immediate questions.
 
For the purpose of this, I've chosen a simple hook only example "Members Online Today" as its very easy to install and a popular choice for a lot of communities.
 
 
1. Having downloaded the file, extract the .zip:
 
hook_install_1_zps8fd04d6e.png
 
 
2. Lets take a look at the contents:
 
hook_install_2_zpsf01b6a91.png
 
We can see the hook xml file itself and some instructions. I won't duplicate the text from those here but its recommended to check the instructions provided by the author regarding the hooks settings (if applicable) and any other features.
 
 
3. We need to upload the hook xml now. Go to your ACP. Click the System tab, then on the left Manage Hooks:
 
hook_install_3_zps27ab9675.png
 
 
4. On the Manage Hooks page, click the "Install Hook" button:
 
hook_install_4_zps74dd5dbe.png
 
 
5. A popup will appear. Browse for and upload the hook xml in the .zip you extracted earlier:
 
hook_install_5_zpsfacb6223.png
 
Don't forget to click "Install"
 
 
6. The hook may take a few moments to install. Once it has finished you'll see a message similar to this, indicating what it has done:
 
hook_install_6_zps253ce477.png
 
 
Scroll down a bit to the list of hooks, and you'll see the hook you just chose has been installed:
 
hook_install_7_zps32e03db2.png
 
 
7. Having already read the instructions included in the hook (you did read them yes ?) you'll know it has some settings, so on the System tab, click System Settings on the left, then the Hooks tab in the settings list and you'll see the settings for this hook:
 
hook_install_8_zps8b76426c.png
 
 
8.Lets take a quick look at this hooks settings, they are self explanatory and just adjust as required not forgetting to save them:
 
hook_install_9_zps881f9678.png
 
Remember not all hooks have settings, always refer to the instructions that accompany a hook or if in doubt ask in its support topic.
 
 
9. Now we've set it as we wanted to, we know this hook displays on the board index in the stats (as per the instructions) so lets check our board to see what its done:
 
hook_install_10_zps8643de5c.png
 
As you can see its working. You can return to Manage Hooks to disable and / or install any hook at a future point.



Recommended Comments

There are no comments to display.

×