Hook attach

From Sohowiki
(Difference between revisions)
Jump to: navigation, search
(hook_attach)
Line 1: Line 1:
'''hook_attach'''<br>
+
'''hook_attach(plugin file, hook id name)'''
hook_attach(plugin file, hook id name)
+
  
  

Revision as of 17:54, 18 May 2006

hook_attach(plugin file, hook id name)


Description
Includes (attaches) your custom script (plugin file) at a pre-designated place (hook id) in the Pro Edition source code.


Example 1 - What a designated hook looks like in the Pro Edition source code
Taken from in sohoadmin/program/header.php (~line #375 as of v4.9 Beta2)

eval(hook("header.php:top_javascript", basename(__FILE__)));


Example 2 - calling hook attachement() from your install_manifest.php
Taken from QuickEdit Dropdown Menu plugin

hook_attach("quickedit_js.php", "header.php:top_javascript");


The end-result of examples 1 and 2 is that Pro Edition will include() your script at the designated location (determined by hook id). So when Pro Edition processes header.php and gets to that line with a hook() on it that your plugin has attached to (by calling hook_attach in its install_manifest.php), it basically does this...

include("[path_your_plugin_folder]/quickedit_js.php");
Personal tools