X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=doc%2Fplugin.txt;h=a05a67096ae76fb64d8a11144f909834456c1ad1;hb=8ddc4111412e862064e7940036f276ea87b496d6;hp=2e8f354aa968fec36b43f548f6b9fbbffe383e58;hpb=3751dc7f2496f452e00dc7410136a0aec101d797;p=squirrelmail.git diff --git a/doc/plugin.txt b/doc/plugin.txt index 2e8f354a..a05a6709 100644 --- a/doc/plugin.txt +++ b/doc/plugin.txt @@ -1,16 +1,21 @@ -A FEW NOTES ON THE PLUGIN ARCHITECTURE -====================================== +$Id$ + +It is best if you check out the SquirrelMail development FAQ for more +information. This document may be obsoleted at some point in the future (or +maybe we'll write a script to get the wiki contents and dump them in here +automatically). -The plugin architecture of SquirrelMail is designed to make it -possible to add new features without having to patch SquirrelMail -itself. At the moment the plugin part of SquirrelMail should be -considered "alpha" or "beta" quality code. +FAQ -> http://www.squirrelmail.org/wiki/wiki.php?DeveloperFAQ +Plugin Hooks -> http://www.squirrelmail.org/wiki/wiki.php?DevelopingPlugins -Until the functionality and code is more stable, be prepared for -plugins to suddenly stop working. -Functionality like password changing, displaying ads and calendars -should be possible to add as plugins. +A FEW NOTES ON THE PLUGIN ARCHITECTURE +====================================== + +The plugin architecture of SquirrelMail is designed to make it possible to +add new features without having to patch SquirrelMail itself. Functionality +like password changing, displaying ads and calendars should be possible to +add as plugins. The idea @@ -34,9 +39,9 @@ The implementation In the main SquirrelMail files the file functions/plugin.php. In places where hooks are made available they are executed by calling the -function do_hook("hookname"). +function do_hook('hookname'). -The do_hook traverses the array $squirrelmail_plugin_hooks["hookname"] +The do_hook traverses the array $squirrelmail_plugin_hooks['hookname'] and executes all the functions that are named in that array. A plugin must reside in a subdirectory in the plugins/ directory. The @@ -45,7 +50,7 @@ name of the subdirectory is considered the name of the plugin. To start using a plugin, its name must be added to the $plugins array in config.php like this: - $plugins[0] = "plugin_name"; + $plugins[0] = 'plugin_name'; When a plugin is registered the file plugins/plugin_name/setup.php is included and the function squirrelmail_plugin_init_plugin_name is @@ -64,22 +69,35 @@ initalize a plugin. This function could look something like this: function squirrelmail_plugin_init_demo () { global $squirrelmail_plugin_hooks; - $squirrelmail_plugin_hooks["generic_header"]["demo"] = "plugin_demo_header"; - $squirrelmail_plugin_hooks["menuline"]["demo"] = "plugin_demo_menuline"; + $squirrelmail_plugin_hooks['generic_header']['demo'] = 'plugin_demo_header'; + $squirrelmail_plugin_hooks['menuline']['demo'] = 'plugin_demo_menuline'; } Note that the SquirrelMail files assume that all other SquirrelMail files are available as ../directory/file. This means that if some file -in the plugin directory is requested, it must do a chdir("..") before +in the plugin directory is requested, it must do a chdir('..') before including any of the standard SquirrelMail files. +Hook Data Passed +---------------- +Hooks, when executed, are called with one parameter, an array of data +that is passed to the hook. The first element in the array is the name +of the hook that is being called. Any other elements in the array are +dependant on the type of hook that is being called. + +Some of the information in the array may be changed. By default, the +plugins should never change data unless it is documented otherwise. + + List of hooks ------------- generic_header functions/page_header.php menuline functions/page_header.php compose_button_row src/compose.php compose_bottom src/compose.php + compose_form src/compose.php + compose_send src/compose.php left_main_before src/left_main.php left_main_after src/left_main.php * options_save src/options.php (see note on options) @@ -94,28 +112,41 @@ List of hooks * options_folders_bottom src/options_folders.php * options_folders_inside src/options_folders.php * options_folders_save src/options_folders.php + & options_identities_process src/options_identities.php + & options_identities_top src/options_identities.php + & options_identities_renumber src/options_identities.php (multiple places) + & options_identities_table src/options_identities.php + & options_identities_buttons src/options_identities.php logout src/signout.php + logout_above_text src/signout.php login_before src/webmail.php login_verified src/webmail.php loading_prefs src/load_prefs.php mailbox_index_before functions/mailbox_display.php mailbox_index_after functions/mailbox_display.php mailbox_form_before functions/mailbox_display.php + subject_link functions/mailbox_display.php + motd src/right_main.php right_main_after_header src/right_main.php right_main_bottom src/right_main.php login_top src/login.php login_bottom src/login.php + html_top src/read_body.php read_body_top src/read_body.php read_body_bottom src/read_body.php + html_bottom src/read_body.php + read_body_header src/read_body.php + read_body_header_right src/read_body.php + read_body_after_from src/read_body.php search_before_form src/search.php search_after_form src/search.php search_bottom src/search.php help_top src/help.php help_bottom src/help.php help_chapter src/help.php - abook_html_search_below src/addrbook_search_html.php + addrbook_html_search_below src/addrbook_search_html.php addressbook_bottom src/addressbook.php - attachment $type0/$type1 functions/mime.php + ^ attachment $type0/$type1 functions/mime.php (see note on attachments) (*) Options ----------- @@ -154,21 +185,22 @@ It is possible to create your own options sections with plugins. There are three hooks you will need to use. 1. options_link_and_description - This creates the link and has a description that are shown on the options - page. This should output HTML that looks like this: + This creates the link and has a description that is shown on the options + page. This should output HTML that looks like this. Make sure to read + the section on outputing your own pages. -----cut here----- - function my_function() { + function my_plugin_name_my_function() { global $color ?>
+ | YOUR OPTIONS NAME |
+ | YOUR DESCRIPTION |