1 Friendica Addon/Plugin development
2 ==========================
4 Please see the sample addon 'randplace' for a working example of using some of these features.
5 The facebook addon provides an example of integrating both "addon" and "module" functionality.
6 Addons work by intercepting event hooks - which must be registered.
7 Modules work by intercepting specific page requests (by URL path).
9 Plugin names cannot contain spaces or other punctuation and are used as filenames and function names.
10 You may supply a "friendly" name within the comment block.
11 Each addon must contain both an install and an uninstall function based on the addon/plugin name.
12 For instance "plugin1name_install()".
13 These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your plugin will require.
14 The install and uninstall functions will also be called (i.e. re-installed) if the plugin changes after installation.
15 Therefore your uninstall should not destroy data and install should consider that data may already exist.
16 Future extensions may provide for "setup" amd "remove".
18 Plugins should contain a comment block with the four following parameters:
21 * Name: My Great Plugin
22 * Description: This is what my plugin does. It's really cool
24 * Author: John Q. Public <john@myfriendicasite.com>
27 Register your plugin hooks during installation.
29 register_hook($hookname, $file, $function);
31 $hookname is a string and corresponds to a known Friendica hook.
33 $file is a pathname relative to the top-level Friendica directory.
34 This *should* be 'addon/plugin_name/plugin_name.php' in most cases.
36 $function is a string and is the name of the function which will be executed when the hook is called.
40 Your hook callback functions will be called with at least one and possibly two arguments
42 function myhook_function(&$a, &$b) {
47 If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration.
50 $a is the Friendica 'App' class.
51 It contains a wealth of information about the current state of Friendica:
53 * which module has been called,
54 * configuration information,
55 * the page contents at the point the hook was invoked,
56 * profile and user information, etc.
58 It is recommeded you call this '$a' to match its usage elsewhere.
61 $b can be called anything you like.
62 This is information specific to the hook currently being processed, and generally contains information that is being immediately processed or acted on that you can use, display, or alter.
63 Remember to declare it with '&' if you wish to alter it.
68 Plugins/addons may also act as "modules" and intercept all page requests for a given URL path.
69 In order for a plugin to act as a module it needs to define a function "plugin_name_module()" which takes no arguments and needs not do anything.
71 If this function exists, you will now receive all page requests for "http://my.web.site/plugin_name" - with any number of URL components as additional arguments.
72 These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
73 So http://my.web.site/plugin/arg1/arg2 would look for a module named "plugin" and pass its module functions the $a App structure (which is available to many components).
77 $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
79 Your module functions will often contain the function plugin_name_content(&$a), which defines and returns the page body content.
80 They may also contain plugin_name_post(&$a) which is called before the _content function and typically handles the results of POST forms.
81 You may also have plugin_name_init(&$a) which is called very early on and often does module initialisation.
86 If your plugin needs some template, you can use the Friendica template system.
87 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
89 Put your tpl files in the *templates/* subfolder of your plugin.
91 In your code, like in the function plugin_name_content(), load the template file and execute it passing needed values:
93 # load template file. first argument is the template name,
94 # second is the plugin path relative to friendica top folder
95 $tpl = get_markup_template('mytemplate.tpl', 'addon/plugin_name/');
97 # apply template. first argument is the loaded template,
98 # second an array of 'name'=>'values' to pass to template
99 $output = replace_macros($tpl,array(
100 'title' => 'My beautiful plugin',
103 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
109 'authenticate' is called when a user attempts to login.
110 $b is an array containing:
112 'username' => the supplied username
113 'password' => the supplied password
114 'authenticated' => set this to non-zero to authenticate the user.
115 'user_record' => successful authentication must also return a valid user record from the database
118 'logged_in' is called after a user has successfully logged in.
119 $b contains the $a->user array.
122 'display_item' is called when formatting a post for display.
125 'item' => The item (array) details pulled from the database
126 'output' => the (string) HTML representation of this item prior to adding it to the page
129 * called when a status post or comment is entered on the local system
130 * $b is the item array of the information to be stored in the database
131 * Please note: body contents are bbcode - not HTML
134 * called when a local status post or comment has been stored on the local system
135 * $b is the item array of the information which has just been stored in the database
136 * Please note: body contents are bbcode - not HTML
139 * called when receiving a post from another source. This may also be used to post local activity or system generated messages.
140 * $b is the item array of information to be stored in the database and the item body is bbcode.
143 * called when generating the HTML for the user Settings page
144 * $b is the (string) HTML of the settings page before the final '</form>' tag.
147 * called when the Settings pages are submitted
148 * $b is the $_POST array
151 * called when generating the HTML for the addon settings page
152 * $b is the (string) HTML of the addon settings page before the final '</form>' tag.
154 ###'plugin_settings_post'
155 * called when the Addon Settings pages are submitted
156 * $b is the $_POST array
159 * called when posting a profile page
160 * $b is the $_POST array
163 'profile_edit' is called prior to output of profile edit page.
164 $b is an array containing:
166 'profile' => profile (array) record from the database
167 'entry' => the (string) HTML of the generated entry
169 ###'profile_advanced'
170 * called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page
171 * $b is the (string) HTML representation of the generated profile
172 * The profile array details are in $a->profile.
175 'directory_item' is called from the Directory page when formatting an item for display.
178 'contact' => contact (array) record for the person from the database
179 'entry' => the (string) HTML of the generated entry
181 ###'profile_sidebar_enter'
182 * called prior to generating the sidebar "short" profile for a page
183 * $b is the person's profile array
186 'profile_sidebar is called when generating the sidebar "short" profile for a page.
189 'profile' => profile (array) record for the person from the database
190 'entry' => the (string) HTML of the generated entry
192 ###'contact_block_end'
193 is called when formatting the block of contacts/friends on a profile sidebar has completed.
196 'contacts' => array of contacts
197 'output' => the (string) generated HTML of the contact block
200 * called during conversion of bbcode to html
201 * $b is a string converted text
204 * called during conversion of html to bbcode (e.g. remote message posting)
205 * $b is a string converted text
208 * called after building the page navigation section
209 * $b is a string HTML of nav region
212 'personal_xrd' is called prior to output of personal XRD file.
215 'user' => the user record for the person
216 'xml' => the complete XML to be output
219 * called prior to output home page content, shown to unlogged users
220 * $b is (string) HTML of section region
223 is called when editing contact details on an individual from the Contacts page.
226 'contact' => contact record (array) of target contact
227 'output' => the (string) generated HTML of the contact edit page
229 ###'contact_edit_post'
230 * called when posting the contact edit page.
231 * $b is the $_POST array
234 * called just after DB has been opened and before session start
235 * $b is not used or passed
238 * called after HTML content functions have completed
239 * $b is (string) HTML of content div
242 'avatar_lookup' is called when looking up the avatar.
245 'size' => the size of the avatar that will be looked up
246 'email' => email to look up the avatar for
247 'url' => the (string) generated URL of the avatar
249 ###'emailer_send_prepare'
250 'emailer_send_prepare' called from Emailer::send() before building the mime message.
251 $b is an array, params to Emailer::send()
253 'fromName' => name of the sender
254 'fromEmail' => email fo the sender
255 'replyTo' => replyTo address to direct responses
256 'toEmail' => destination email address
257 'messageSubject' => subject of the message
258 'htmlVersion' => html version of the message
259 'textVersion' => text only version of the message
260 'additionalMailHeader' => additions to the smtp mail header
263 is called before calling PHP's mail().
264 $b is an array, params to mail()
272 is called after the navigational menu is build in include/nav.php.
273 $b is an array containing $nav from nav.php.
275 Complete list of hook callbacks
278 Here is a complete list of all hook callbacks with file locations (as of 14-Feb-2012). Please see the source for details of any hooks not documented above.
280 boot.php: call_hooks('login_hook',$o);
282 boot.php: call_hooks('profile_sidebar_enter', $profile);
284 boot.php: call_hooks('profile_sidebar', $arr);
286 boot.php: call_hooks("proc_run", $arr);
288 include/contact_selectors.php: call_hooks('network_to_name', $nets);
290 include/api.php: call_hooks('logged_in', $a->user);
292 include/api.php: call_hooks('logged_in', $a->user);
294 include/queue.php: call_hooks('queue_predeliver', $a, $r);
296 include/queue.php: call_hooks('queue_deliver', $a, $params);
298 include/text.php: call_hooks('contact_block_end', $arr);
300 include/text.php: call_hooks('smilie', $s);
302 include/text.php: call_hooks('prepare_body_init', $item);
304 include/text.php: call_hooks('prepare_body', $prep_arr);
306 include/text.php: call_hooks('prepare_body_final', $prep_arr);
308 include/nav.php: call_hooks('page_header', $a->page['nav']);
310 include/auth.php: call_hooks('authenticate', $addon_auth);
312 include/bbcode.php: call_hooks('bbcode',$Text);
314 include/oauth.php: call_hooks('logged_in', $a->user);
316 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
318 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
320 include/acl_selectors.php: call_hooks('contact_select_options', $x);
322 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
324 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
326 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
328 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
330 include/notifier.php: call_hooks('notifier_normal',$target_item);
332 include/notifier.php: call_hooks('notifier_end',$target_item);
334 include/items.php: call_hooks('atom_feed', $atom);
336 include/items.php: call_hooks('atom_feed_end', $atom);
338 include/items.php: call_hooks('atom_feed_end', $atom);
340 include/items.php: call_hooks('parse_atom', $arr);
342 include/items.php: call_hooks('post_remote',$arr);
344 include/items.php: call_hooks('atom_author', $o);
346 include/items.php: call_hooks('atom_entry', $o);
348 include/bb2diaspora.php: call_hooks('bb2diaspora',$Text);
350 include/cronhooks.php: call_hooks('cron', $d);
352 include/security.php: call_hooks('logged_in', $a->user);
354 include/html2bbcode.php: call_hooks('html2bbcode', $text);
356 include/Contact.php: call_hooks('remove_user',$r[0]);
358 include/Contact.php: call_hooks('contact_photo_menu', $args);
360 include/conversation.php: call_hooks('conversation_start',$cb);
362 include/conversation.php: call_hooks('render_location',$locate);
364 include/conversation.php: call_hooks('display_item', $arr);
366 include/conversation.php: call_hooks('render_location',$locate);
368 include/conversation.php: call_hooks('display_item', $arr);
370 include/conversation.php: call_hooks('item_photo_menu', $args);
372 include/conversation.php: call_hooks('jot_tool', $jotplugins);
374 include/conversation.php: call_hooks('jot_networks', $jotnets);
376 include/plugin.php:if(! function_exists('call_hooks')) {
378 include/plugin.php:function call_hooks($name, &$data = null) {
380 index.php: call_hooks('init_1');
382 index.php:call_hooks('app_menu', $arr);
384 index.php:call_hooks('page_end', $a->page['content']);
386 mod/photos.php: call_hooks('photo_post_init', $_POST);
388 mod/photos.php: call_hooks('photo_post_file',$ret);
390 mod/photos.php: call_hooks('photo_post_end',$foo);
392 mod/photos.php: call_hooks('photo_post_end',$foo);
394 mod/photos.php: call_hooks('photo_post_end',$foo);
396 mod/photos.php: call_hooks('photo_post_end',intval($item_id));
398 mod/photos.php: call_hooks('photo_upload_form',$ret);
400 mod/friendica.php: call_hooks('about_hook', $o);
402 mod/editpost.php: call_hooks('jot_tool', $jotplugins);
404 mod/editpost.php: call_hooks('jot_networks', $jotnets);
406 mod/parse_url.php: call_hooks('parse_link', $arr);
408 mod/home.php: call_hooks('home_init',$ret);
410 mod/home.php: call_hooks("home_content",$o);
412 mod/contacts.php: call_hooks('contact_edit_post', $_POST);
414 mod/contacts.php: call_hooks('contact_edit', $arr);
416 mod/settings.php: call_hooks('plugin_settings_post', $_POST);
418 mod/settings.php: call_hooks('connector_settings_post', $_POST);
420 mod/settings.php: call_hooks('settings_post', $_POST);
422 mod/settings.php: call_hooks('plugin_settings', $settings_addons);
424 mod/settings.php: call_hooks('connector_settings', $settings_connectors);
426 mod/settings.php: call_hooks('settings_form',$o);
428 mod/register.php: call_hooks('register_account', $newuid);
430 mod/like.php: call_hooks('post_local_end', $arr);
432 mod/xrd.php: call_hooks('personal_xrd', $arr);
434 mod/item.php: call_hooks('post_local_start', $_REQUEST);
436 mod/item.php: call_hooks('post_local',$datarray);
438 mod/item.php: call_hooks('post_local_end', $datarray);
440 mod/profile.php: call_hooks('profile_advanced',$o);
442 mod/profiles.php: call_hooks('profile_post', $_POST);
444 mod/profiles.php: call_hooks('profile_edit', $arr);
446 mod/tagger.php: call_hooks('post_local_end', $arr);
448 mod/cb.php: call_hooks('cb_init');
450 mod/cb.php: call_hooks('cb_post', $_POST);
452 mod/cb.php: call_hooks('cb_afterpost');
454 mod/cb.php: call_hooks('cb_content', $o);
456 mod/directory.php: call_hooks('directory_item', $arr);