1 Friendica Addon development
6 Please see the sample addon 'randplace' for a working example of using some of these features.
7 Addons work by intercepting event hooks - which must be registered.
8 Modules work by intercepting specific page requests (by URL path).
10 Addon names cannot contain spaces or other punctuation and are used as filenames and function names.
11 You may supply a "friendly" name within the comment block.
12 Each addon must contain both an install and an uninstall function based on the addon name.
13 For instance "addon1name_install()".
14 These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your addon will require.
15 The install and uninstall functions will also be called (i.e. re-installed) if the addon changes after installation.
16 Therefore your uninstall should not destroy data and install should consider that data may already exist.
17 Future extensions may provide for "setup" amd "remove".
19 Addons should contain a comment block with the four following parameters:
22 * Name: My Great Addon
23 * Description: This is what my addon does. It's really cool.
25 * Author: John Q. Public <john@myfriendicasite.com>
28 Please also add a README or README.md file to the addon directory.
29 It will be displayed in the admin panel and should include some further information in addition to the header information.
34 Register your addon hooks during installation.
36 Addon::registerHook($hookname, $file, $function);
38 $hookname is a string and corresponds to a known Friendica PHP hook.
40 $file is a pathname relative to the top-level Friendica directory.
41 This *should* be 'addon/*addon_name*/*addon_name*.php' in most cases.
43 $function is a string and is the name of the function which will be executed when the hook is called.
46 Your hook callback functions will be called with at least one and possibly two arguments
48 function myhook_function(App $a, &$b) {
53 If you wish to make changes to the calling data, you must declare them as reference variables (with '&') during function declaration.
56 $a is the Friendica 'App' class.
57 It contains a wealth of information about the current state of Friendica:
59 * which module has been called,
60 * configuration information,
61 * the page contents at the point the hook was invoked,
62 * profile and user information, etc.
64 It is recommeded you call this '$a' to match its usage elsewhere.
67 $b can be called anything you like.
68 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.
69 Remember to declare it with '&' if you wish to alter it.
71 JavaScript addon hooks
74 Register your addon hooks in file 'addon/*addon_name*/*addon_name*.js'.
76 Addon_registerHook(type,hookfnstr);
78 *type* is the name of the hook and corresponds to a known Friendica JavaScript hook.
79 *hookfnstr* is the name of your JavaScript function to execute.
81 No arguments are provided to your JavaScript callback function. Example:
83 function myhook_function() {
90 Addons may also act as "modules" and intercept all page requests for a given URL path.
91 In order for a addon to act as a module it needs to define a function "addon_name_module()" which takes no arguments and needs not do anything.
93 If this function exists, you will now receive all page requests for "http://my.web.site/addon_name" - with any number of URL components as additional arguments.
94 These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
95 So http://my.web.site/addon/arg1/arg2 would look for a module named "addon" and pass its module functions the $a App structure (which is available to many components).
99 $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
101 Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
102 They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
103 You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
108 If your addon needs some template, you can use the Friendica template system.
109 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
111 Put your tpl files in the *templates/* subfolder of your addon.
113 In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
115 # load template file. first argument is the template name,
116 # second is the addon path relative to friendica top folder
117 $tpl = get_markup_template('mytemplate.tpl', 'addon/addon_name/');
119 # apply template. first argument is the loaded template,
120 # second an array of 'name'=>'values' to pass to template
121 $output = replace_macros($tpl,array(
122 'title' => 'My beautiful addon',
125 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
131 'authenticate' is called when a user attempts to login.
132 $b is an array containing:
134 'username' => the supplied username
135 'password' => the supplied password
136 'authenticated' => set this to non-zero to authenticate the user.
137 'user_record' => successful authentication must also return a valid user record from the database
140 'logged_in' is called after a user has successfully logged in.
141 $b contains the $a->user array.
144 'display_item' is called when formatting a post for display.
147 'item' => The item (array) details pulled from the database
148 'output' => the (string) HTML representation of this item prior to adding it to the page
151 * called when a status post or comment is entered on the local system
152 * $b is the item array of the information to be stored in the database
153 * Please note: body contents are bbcode - not HTML
156 * called when a local status post or comment has been stored on the local system
157 * $b is the item array of the information which has just been stored in the database
158 * Please note: body contents are bbcode - not HTML
161 * called when receiving a post from another source. This may also be used to post local activity or system generated messages.
162 * $b is the item array of information to be stored in the database and the item body is bbcode.
165 * called when generating the HTML for the user Settings page
166 * $b is the (string) HTML of the settings page before the final '</form>' tag.
169 * called when the Settings pages are submitted
170 * $b is the $_POST array
173 * called when generating the HTML for the addon settings page
174 * $b is the (string) HTML of the addon settings page before the final '</form>' tag.
176 ### 'addon_settings_post'
177 * called when the Addon Settings pages are submitted
178 * $b is the $_POST array
181 * called when posting a profile page
182 * $b is the $_POST array
185 'profile_edit' is called prior to output of profile edit page.
186 $b is an array containing:
188 'profile' => profile (array) record from the database
189 'entry' => the (string) HTML of the generated entry
191 ### 'profile_advanced'
192 * called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page
193 * $b is the (string) HTML representation of the generated profile
194 * The profile array details are in $a->profile.
197 'directory_item' is called from the Directory page when formatting an item for display.
200 'contact' => contact (array) record for the person from the database
201 'entry' => the (string) HTML of the generated entry
203 ### 'profile_sidebar_enter'
204 * called prior to generating the sidebar "short" profile for a page
205 * $b is the person's profile array
207 ### 'profile_sidebar'
208 'profile_sidebar is called when generating the sidebar "short" profile for a page.
211 'profile' => profile (array) record for the person from the database
212 'entry' => the (string) HTML of the generated entry
214 ### 'contact_block_end'
215 is called when formatting the block of contacts/friends on a profile sidebar has completed.
218 'contacts' => array of contacts
219 'output' => the (string) generated HTML of the contact block
222 * called during conversion of bbcode to html
223 * $b is a string converted text
226 * called during conversion of html to bbcode (e.g. remote message posting)
227 * $b is a string converted text
230 * called after building the page navigation section
231 * $b is a string HTML of nav region
234 'personal_xrd' is called prior to output of personal XRD file.
237 'user' => the user record for the person
238 'xml' => the complete XML to be output
241 * called prior to output home page content, shown to unlogged users
242 * $b is (string) HTML of section region
245 is called when editing contact details on an individual from the Contacts page.
248 'contact' => contact record (array) of target contact
249 'output' => the (string) generated HTML of the contact edit page
251 ### 'contact_edit_post'
252 * called when posting the contact edit page.
253 * $b is the $_POST array
256 * called just after DB has been opened and before session start
257 * $b is not used or passed
260 * called after HTML content functions have completed
261 * $b is (string) HTML of content div
264 'avatar_lookup' is called when looking up the avatar.
267 'size' => the size of the avatar that will be looked up
268 'email' => email to look up the avatar for
269 'url' => the (string) generated URL of the avatar
271 ### 'emailer_send_prepare'
272 'emailer_send_prepare' called from Emailer::send() before building the mime message.
273 $b is an array, params to Emailer::send()
275 'fromName' => name of the sender
276 'fromEmail' => email fo the sender
277 'replyTo' => replyTo address to direct responses
278 'toEmail' => destination email address
279 'messageSubject' => subject of the message
280 'htmlVersion' => html version of the message
281 'textVersion' => text only version of the message
282 'additionalMailHeader' => additions to the smtp mail header
285 is called before calling PHP's mail().
286 $b is an array, params to mail()
294 is called after the navigational menu is build in include/nav.php.
295 $b is an array containing $nav from nav.php.
298 is called before vars are passed to the template engine to render the page.
299 The registered function can add,change or remove variables passed to template.
302 'template' => filename of template
303 'vars' => array of vars passed to template
306 is called after the other queries have passed.
307 The registered function can add, change or remove the acl_lookup() variables.
309 'results' => array of the acl_lookup() vars
311 ### 'prepare_body_init'
312 Called at the start of prepare_body
314 'item' => item array (input/output)
316 ### 'prepare_body_content_filter'
317 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
318 just add the reason to the filter_reasons element of the hook data.
320 'item' => item array (input)
321 'filter_reasons' => reasons array (input/output)
324 Called after the HTML conversion in prepare_body.
326 'item' => item array (input)
327 'html' => converted item body (input/output)
328 'is_preview' => post preview flag (input)
329 'filter_reasons' => reasons array (input)
331 ### 'prepare_body_final'
332 Called at the end of prepare_body.
334 'item' => item array (input)
335 'html' => converted item body (input/output)
337 Current JavaScript hooks
340 ### 'postprocess_liveupdate'
341 Called at the end of the live update process (XmlHttpRequest)
343 Complete list of hook callbacks
346 Here is a complete list of all hook callbacks with file locations (as of 01-Apr-2018). Please see the source for details of any hooks not documented above.
350 Addon::callHooks('init_1');
351 Addon::callHooks('app_menu', $arr);
352 Addon::callHooks('page_content_top', $a->page['content']);
353 Addon::callHooks($a->module.'_mod_init', $placeholder);
354 Addon::callHooks($a->module.'_mod_init', $placeholder);
355 Addon::callHooks($a->module.'_mod_post', $_POST);
356 Addon::callHooks($a->module.'_mod_afterpost', $placeholder);
357 Addon::callHooks($a->module.'_mod_content', $arr);
358 Addon::callHooks($a->module.'_mod_aftercontent', $arr);
359 Addon::callHooks('page_end', $a->page['content']);
363 Addon::callHooks('logged_in', $a->user);
364 Addon::callHooks('authenticate', $addon_auth);
365 Addon::callHooks('logged_in', $a->user);
367 ### include/enotify.php
369 Addon::callHooks('enotify', $h);
370 Addon::callHooks('enotify_store', $datarray);
371 Addon::callHooks('enotify_mail', $datarray);
372 Addon::callHooks('check_item_notification', $notification_data);
374 ### include/conversation.php
376 Addon::callHooks('conversation_start', $cb);
377 Addon::callHooks('render_location', $locate);
378 Addon::callHooks('display_item', $arr);
379 Addon::callHooks('display_item', $arr);
380 Addon::callHooks('item_photo_menu', $args);
381 Addon::callHooks('jot_tool', $jotplugins);
383 ### include/security.php
385 Addon::callHooks('logged_in', $a->user);
389 Addon::callHooks('contact_block_end', $arr);
390 Addon::callHooks('poke_verbs', $arr);
391 Addon::callHooks('prepare_body_init', $item);
392 Addon::callHooks('prepare_body_content_filter', $hook_data);
393 Addon::callHooks('prepare_body', $hook_data);
394 Addon::callHooks('prepare_body_final', $hook_data);
396 ### include/items.php
398 Addon::callHooks('page_info_data', $data);
400 ### mod/directory.php
402 Addon::callHooks('directory_item', $arr);
406 Addon::callHooks('personal_xrd', $arr);
410 Addon::callHooks('network_ping', $arr);
412 ### mod/parse_url.php
414 Addon::callHooks("parse_link", $arr);
418 Addon::callHooks('home_init', $ret);
422 Addon::callHooks('acl_lookup_end', $results);
426 Addon::callHooks('network_content_init', $arr);
427 Addon::callHooks('network_tabs', $arr);
429 ### mod/friendica.php
431 Addon::callHooks('about_hook', $o);
433 ### mod/subthread.php
435 Addon::callHooks('post_local_end', $arr);
439 Addon::callHooks('profile_post', $_POST);
440 Addon::callHooks('profile_edit', $arr);
444 Addon::callHooks('addon_settings_post', $_POST);
445 Addon::callHooks('connector_settings_post', $_POST);
446 Addon::callHooks('display_settings_post', $_POST);
447 Addon::callHooks('settings_post', $_POST);
448 Addon::callHooks('addon_settings', $settings_addons);
449 Addon::callHooks('connector_settings', $settings_connectors);
450 Addon::callHooks('display_settings', $o);
451 Addon::callHooks('settings_form', $o);
455 Addon::callHooks('photo_post_init', $_POST);
456 Addon::callHooks('photo_post_file', $ret);
457 Addon::callHooks('photo_post_end', $foo);
458 Addon::callHooks('photo_post_end', $foo);
459 Addon::callHooks('photo_post_end', $foo);
460 Addon::callHooks('photo_post_end', $foo);
461 Addon::callHooks('photo_post_end', intval($item_id));
462 Addon::callHooks('photo_upload_form', $ret);
466 Addon::callHooks('profile_advanced', $o);
470 Addon::callHooks('home_init', $ret);
471 Addon::callHooks("home_content", $content);
475 Addon::callHooks('post_local_end', $arr);
479 Addon::callHooks('contact_edit_post', $_POST);
480 Addon::callHooks('contact_edit', $arr);
484 Addon::callHooks('post_local_end', $arr);
488 Addon::callHooks('lockview_content', $item);
492 Addon::callHooks('uexport_options', $options);
496 Addon::callHooks('register_post', $arr);
497 Addon::callHooks('register_form', $arr);
501 Addon::callHooks('post_local_start', $_REQUEST);
502 Addon::callHooks('post_local', $datarray);
503 Addon::callHooks('post_local_end', $datarray);
507 Addon::callHooks('jot_tool', $jotplugins);
509 ### src/Network/FKOAuth1.php
511 Addon::callHooks('logged_in', $a->user);
513 ### src/Render/FriendicaSmartyEngine.php
515 Addon::callHooks("template_vars", $arr);
517 ### src/Model/Item.php
519 Addon::callHooks('post_local', $item);
520 Addon::callHooks('post_remote', $item);
521 Addon::callHooks('post_local_end', $posted_item);
522 Addon::callHooks('post_remote_end', $posted_item);
523 Addon::callHooks('tagged', $arr);
524 Addon::callHooks('post_local_end', $new_item);
526 ### src/Model/Contact.php
528 Addon::callHooks('contact_photo_menu', $args);
529 Addon::callHooks('follow', $arr);
531 ### src/Model/Profile.php
533 Addon::callHooks('profile_sidebar_enter', $profile);
534 Addon::callHooks('profile_sidebar', $arr);
535 Addon::callHooks('profile_tabs', $arr);
536 Addon::callHooks('zrl_init', $arr);
538 ### src/Model/Event.php
540 Addon::callHooks('event_updated', $event['id']);
541 Addon::callHooks("event_created", $event['id']);
543 ### src/Model/User.php
545 Addon::callHooks('register_account', $uid);
546 Addon::callHooks('remove_user', $user);
548 ### src/Content/Text/BBCode.php
550 Addon::callHooks('bbcode', $text);
551 Addon::callHooks('bb2diaspora', $text);
553 ### src/Content/Text/HTML.php
555 Addon::callHooks('html2bbcode', $message);
557 ### src/Content/Smilies.php
559 Addon::callHooks('smilie', $params);
561 ### src/Content/Feature.php
563 Addon::callHooks('isEnabled', $arr);
564 Addon::callHooks('get', $arr);
566 ### src/Content/ContactSelector.php
568 Addon::callHooks('network_to_name', $nets);
569 Addon::callHooks('gender_selector', $select);
570 Addon::callHooks('sexpref_selector', $select);
571 Addon::callHooks('marital_selector', $select);
573 ### src/Content/OEmbed.php
575 Addon::callHooks('oembed_fetch_url', $embedurl, $j);
577 ### src/Content/Nav.php
579 Addon::callHooks('page_header', $a->page['nav']);
580 Addon::callHooks('nav_info', $nav);
582 ### src/Worker/Directory.php
584 Addon::callHooks('globaldir_update', $arr);
586 ### src/Worker/Notifier.php
588 Addon::callHooks('notifier_end', $target_item);
590 ### src/Worker/Queue.php
592 Addon::callHooks('queue_predeliver', $r);
593 Addon::callHooks('queue_deliver', $params);
595 ### src/Module/Login.php
597 Addon::callHooks('authenticate', $addon_auth);
598 Addon::callHooks('login_hook', $o);
600 ### src/Module/Logout.php
602 Addon::callHooks("logging_out");
604 ### src/Object/Post.php
606 Addon::callHooks('render_location', $locate);
607 Addon::callHooks('display_item', $arr);
611 Addon::callHooks('contact_select_options', $x);
612 Addon::callHooks($a->module.'_pre_'.$selname, $arr);
613 Addon::callHooks($a->module.'_post_'.$selname, $o);
614 Addon::callHooks($a->module.'_pre_'.$selname, $arr);
615 Addon::callHooks($a->module.'_post_'.$selname, $o);
616 Addon::callHooks('jot_networks', $jotnets);
618 ### src/Core/Worker.php
620 Addon::callHooks("proc_run", $arr);
622 ### src/Util/Emailer.php
624 Addon::callHooks('emailer_send_prepare', $params);
625 Addon::callHooks("emailer_send", $hookdata);
629 Addon::callHooks('generate_map', $arr);
630 Addon::callHooks('generate_named_map', $arr);
631 Addon::callHooks('Map::getCoordinates', $arr);
633 ### src/Util/Network.php
635 Addon::callHooks('avatar_lookup', $avatar);
637 ### src/Util/ParseUrl.php
639 Addon::callHooks("getsiteinfo", $siteinfo);
641 ### src/Protocol/DFRN.php
643 Addon::callHooks('atom_feed_end', $atom);
644 Addon::callHooks('atom_feed_end', $atom);
648 callAddonHooks("postprocess_liveupdate");