Sohowiki Sandbox

From Sohowiki
(Difference between revisions)
Jump to: navigation, search
(hook_overwrite)
(Description)
Line 4: Line 4:
 
hook_attach(plugin file, hook id)
 
hook_attach(plugin file, hook id)
  
===Description===
+
'''Description'''
 
Includes (attaches) your custom script (plugin file) at a pre-designated place (hook id) in the Pro Edition source code.
 
Includes (attaches) your custom script (plugin file) at a pre-designated place (hook id) in the Pro Edition source code.
  

Revision as of 17:18, 18 May 2006

Write now, organize and place later. This is the place to draft content before you know exactly where it should go...also good place for expermimenting with wiki markup.

hook_attach

hook_attach(plugin file, hook id)

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");


All of this effectively tells Pro Edition to include() your script at the designated (by hook id) location. 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");

hook_overwrite

hook_overwrite(source file name, plugin file name)

Description

Completely overwrites a source file with the file you specify.

Original source file is renamed to filename.php-[plugin_folder_name]

Example 1 - calling hook_overwrite from your install_manifest.php

hook_overwrite("sohoadmin/program/main_menu.php", "your_modded_main_menu.php");
Personal tools