[How to] Write Plug-ins/Hooks

[Andreas]

Hmm .... a Query class!
That's what would be needed.

Example

PHP Code:

$query->add_join($table, $alias, $condition);
$query->add_fields(array('field1', 'field2' => 'fieldalias'));
$query->add_condition($operator, $condition);
... 


[amykhar]

Originally Posted by KirbyDE

Hmm .... a Query class!
That's what would be needed.

Example

PHP Code:

$query->add_join($table, $alias, $condition);
$query->add_fields(array('field1', 'field2' => 'fieldalias'));
$query->add_condition($operator, $condition);
... 


Exactly!

[Fusion]

Originally Posted by KirbyDE

Hmm .... a Query class!
That's what would be needed.

Example

PHP Code:

$query->add_join($table, $alias, $condition);
$query->add_fields(array('field1', 'field2' => 'fieldalias'));
$query->add_condition($operator, $condition);
... 


Actually, that's an excellent idea.

[Revan]

I have an addition to this tutorial:

[high]vbulletin_plugins.xml[/high]
If you need to tell your users to add a lot of plugins, this will become tedious as much copy/pasting is required. A simpler way would be to use the .xml import. It works just like the importing of templates and phrases, by adding the contained code as a Plugin.
The correct format for a plugin.xml file is like so (thanks to Live Wire):

<?xml version="1.0" encoding="ISO-8859-1"?>
<plugins>
	<plugin active="1">
		<title>vB Category Icons</title>
		<hookname>forumdata_start</hookname>
		<phpcode><![CDATA[$this->validfields['forumhomeicon'] = array(TYPE_STR, REQ_NO);]]></phpcode>
	</plugin>
</plugins>

Explanations:
<plugin active="1"> - The 'active' attribute determines the default value of 'Plugin is Active' in the Plugin Manager.
<title></title> - Self explanatory, it is the 'Title' field in the Manager.
<hookname></hookname> - The 'Hook Location' you would select.
<phpcode><![CDATA[ ]]></phpcode> - Anything added in the space between these is added to the 'Plugin PHP Code' part.


// end my contribution (if this is being merged into the first post, nothing below this is to be included)

And just for all you lazy people out there, here is an empty set, ready for copypasting into a blank xml file (only the <?xml and <plugins> tags need to be there already):

	<plugin active="1">
		<title></title>
		<hookname></hookname>
		<phpcode><![CDATA[]]></phpcode>
	</plugin>

I hope this helps hack writers that want to minimise the hassle for the end-user

[Cap'n Steve]

Originally Posted by Brad.loo

First and foremost plug-ins are stored in the database, serlized, unserlized and evaled on page generation. If you code preforms badly with such a wrapper forget making a plug-in and just hack it, trust me you'll thank yourself for it when your forum gets large.

Could you elaborate on this? Are there some known problems with eval() or something else?

[Logikos]

Originally Posted by Cap'n Steve

Could you elaborate on this? Are there some known problems with eval() or something else?

What he means is, if your code is just;

PHP Code:

echo $threadid; 


You better off hacking it, as if you add it to the plugin area, it has to call a query just to call that line.

The above is just a stupid example for you to understand better. Obviously we won't be using a echo in our hacks.

[Paul M]

Originally Posted by Revan

I have an addition to this tutorial:

<snip>

If you have developed the plugin on your own board then all you need do is use the plugin manager's download feature to create your ready made xml file for others to use.

[Marco van Herwaarden]

Guys (and girls) please don't use threads in the How-To's forum to say thank you or discuss things. Only post How-To's and additions to them so we can get clean instructions on how to solve problems.

[Andreas]

Something that might come in handy for those developing Plugins:

In class_hook.php FIND

PHP Code:

function &fetch_hook($hookname)
{ 


BELOW that ADD

PHP Code:

DEVDEBUG("Calling Hook $hookname"); 


Then (if debug mode is turned on) you can see which hooks are being called, and when they are being called.

[dwh]

I'm trying to get a handle on these hooks. What if you want to write custom code and just hook it into opening a new pm, or starting a new thread. How would that work?

Also is there a difference between a Plug-In and a Hook or are they the same thing?