[Ken Iovino]

What this is
This guide will teach you to use the hooks system to add options to your admincp/forum.php page. One finished, you will be able to add new options to your forum with just a few lines of code.

Don't understand?
Ever wanted to turn something on, but only in one of your forums? For example, lets say you want to execute code, but only in forum I.D. 2, 16, and 45.

Lets begin!
In this tutorial we will assume that you want a yes or no option; in order to enable/disable some code. In order to do that we first need to create a new row in the database. This will hold the information of which forums will be enabled/disabled. Always remember that '1' is considered as on, or enabled. And that '0' is considered off, or disabled.

Please make sure this is all done on a test forum!

We have to store the data!
Run this SQL Query:

ALTER TABLE forum ADD (
        var smallint(3) unsigned not null default ''
)

Var = The name of the row in the database. This should be a name that will describe your system in one word. For example. In my vB Category Icons hack. This row is named 'forumhomeicon'

Now that we have added our new row named 'var'. We now have to add the on/off option in the forums manager area of the admin control panel.

Add the option in the ACP
To add this new option in the ACP we need to create a new hook and add some code to that hook.

The hook name should be: forumadmin_edit_form
And the code should be:

PHP Code:

print_input_row($vbphrase['your_phrase'], 'forum[var]', $forum['var']); 


Notice the 'var'? Remember, that's the row name!
That will actually add the yes/no row to all your forums in the admincp. So when you click on the save button, it will add your selection to the database.

But how does it know which row to add it to? Glad you asked.

You have to create one more hook!
The hook name should be: forumdata_start
And the code to add there is the following

PHP Code:

$this->validfields['var'] = array(TYPE_STR, REQ_NO); 


Notice the var again? That's telling it which row to add it to.

I want to add more then just one option!
Then you will need to repeat this tutorial for each option you would like to have.

Now that you have saved both hooks. You can now use the following code in any of your hooks.

PHP Code:

if ($foruminfo['var'] == 1)
{
     // your code here
} 


In templates you would use

<if condition="$foruminfo['var'] == 1">
     <!-- Your Code Here -->
</if> 

Big Tip:
If you have 2 or more options being added to the forums, you can place all the code in each hook. For example:

Hookname: forumadmin_edit_form
Code:

PHP Code:

print_input_row($vbphrase['your_phrase'], 'forum[var1]', $forum['var1']);
print_input_row($vbphrase['your_phrase'], 'forum[var2]', $forum['var2']); 


Hook Name: forumdata_start
Code:

PHP Code:

$this->validfields['var1'] = array(TYPE_STR, REQ_NO);
$this->validfields['var2'] = array(TYPE_STR, REQ_NO); 


You don't have to keep creating new hooks for more options for the same hack. Is better to only create hooks for separate hacks.



Custom Fields
The following fields can also be used.

PHP Code:

// This will print an input form. Good for titles, and such.
print_input_row($vbphrase['your_phrase'], 'forum[var]', $forum['var']); 


PHP Code:

//This will print a yes or no row
print_yes_no_row($vbphrase['your_phrase'], 'forum[var]', $forum['var']); 


PHP Code:

//This will print a text area. Good for descriptions
print_textarea_row($vbphrase['your_phrase'], 'forum[var]', $forum['var']); 


There are more that can be used. When I have some more time I will add them all here.

This tutorial was created for a member who needed to know how to do this exact thing, so I figured I would teach everyone. :p

[Arnoud]

Nice guide. Very useful for comparing the changes of vB 3.0.x to 3.5 .

another GREAT valuable tutorial guide, as always.
nice work m8

[derf]

Nice post and easy tut to get a fast grip of coding for 3.5
Thanks a'lot

[mohammed]

thanks livewire

[HDRebel88]

Thanks, very useful..... but how would I go about creating a completely seperate page in the admincp so I can control my featured artist set-up? is it another php page and then what?

[Nick R]

Coding the ACP is the hardest aspect of vB due to the way it works and bugger all for custom coding.

[HDRebel88]

Instead of running a SQL query could I use:

$db->query_write("ALTER TABLE " "forum ADD
(Variable smallint(3) unsigned not null default ''
)");

in the install section for a products install code?

what would be the uninstall code for that?

$db->query("DROP TABLE `" "Variable`;");

[Adrian]

Wow, thanks.

Nice tutorial LiveWire,
Deffinately helped me!

Adrian

[ninjamaster]

thanks for the tut nice work hope to see more