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
75 Make sure your JavaScript addon file (addon/*addon_name*/*addon_name*.js) is listed in the document response.
77 In your addon install function, add:
79 Addon::registerHook('template_vars', 'addon/<addon_name>/<addon_name>.php', '<addon_name>_template_vars');
81 In your addon uninstall function, add:
83 Addon::unregisterHook('template_vars', 'addon/<addon_name>/<addon_name>.php', '<addon_name>_template_vars');
85 Then, add your addon name to the *addon_hooks* template variable array:
87 function <addon_name>_template_vars($a, &$arr)
89 if (!array_key_exists('addon_hooks',$arr['vars']))
91 $arr['vars']['addon_hooks'] = array();
93 $arr['vars']['addon_hooks'][] = "<addon_name>";
97 Register your addon hooks in file 'addon/*addon_name*/*addon_name*.js'.
99 Addon_registerHook(type,hookfnstr);
101 *type* is the name of the hook and corresponds to a known Friendica JavaScript hook.
102 *hookfnstr* is the name of your JavaScript function to execute.
104 No arguments are provided to your JavaScript callback function. Example:
106 function myhook_function() {
113 Addons may also act as "modules" and intercept all page requests for a given URL path.
114 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.
116 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.
117 These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components.
118 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).
122 $a->argv = array(0 => 'addon', 1 => 'arg1', 2 => 'arg2');
124 Your module functions will often contain the function addon_name_content(App $a), which defines and returns the page body content.
125 They may also contain addon_name_post(App $a) which is called before the _content function and typically handles the results of POST forms.
126 You may also have addon_name_init(App $a) which is called very early on and often does module initialisation.
131 If your addon needs some template, you can use the Friendica template system.
132 Friendica uses [smarty3](http://www.smarty.net/) as a template engine.
134 Put your tpl files in the *templates/* subfolder of your addon.
136 In your code, like in the function addon_name_content(), load the template file and execute it passing needed values:
138 # load template file. first argument is the template name,
139 # second is the addon path relative to friendica top folder
140 $tpl = get_markup_template('mytemplate.tpl', 'addon/addon_name/');
142 # apply template. first argument is the loaded template,
143 # second an array of 'name'=>'values' to pass to template
144 $output = replace_macros($tpl,array(
145 'title' => 'My beautiful addon',
148 See also the wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide).
154 'authenticate' is called when a user attempts to login.
155 $b is an array containing:
157 'username' => the supplied username
158 'password' => the supplied password
159 'authenticated' => set this to non-zero to authenticate the user.
160 'user_record' => successful authentication must also return a valid user record from the database
163 'logged_in' is called after a user has successfully logged in.
164 $b contains the $a->user array.
167 'display_item' is called when formatting a post for display.
170 'item' => The item (array) details pulled from the database
171 'output' => the (string) HTML representation of this item prior to adding it to the page
174 * called when a status post or comment is entered on the local system
175 * $b is the item array of the information to be stored in the database
176 * Please note: body contents are bbcode - not HTML
179 * called when a local status post or comment has been stored on the local system
180 * $b is the item array of the information which has just been stored in the database
181 * Please note: body contents are bbcode - not HTML
184 * called when receiving a post from another source. This may also be used to post local activity or system generated messages.
185 * $b is the item array of information to be stored in the database and the item body is bbcode.
188 * called when generating the HTML for the user Settings page
189 * $b is the (string) HTML of the settings page before the final '</form>' tag.
192 * called when the Settings pages are submitted
193 * $b is the $_POST array
196 * called when generating the HTML for the addon settings page
197 * $b is the (string) HTML of the addon settings page before the final '</form>' tag.
199 ### 'addon_settings_post'
200 * called when the Addon Settings pages are submitted
201 * $b is the $_POST array
204 * called when posting a profile page
205 * $b is the $_POST array
208 'profile_edit' is called prior to output of profile edit page.
209 $b is an array containing:
211 'profile' => profile (array) record from the database
212 'entry' => the (string) HTML of the generated entry
214 ### 'profile_advanced'
215 * called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page
216 * $b is the (string) HTML representation of the generated profile
217 * The profile array details are in $a->profile.
220 'directory_item' is called from the Directory page when formatting an item for display.
223 'contact' => contact (array) record for the person from the database
224 'entry' => the (string) HTML of the generated entry
226 ### 'profile_sidebar_enter'
227 * called prior to generating the sidebar "short" profile for a page
228 * $b is the person's profile array
230 ### 'profile_sidebar'
231 'profile_sidebar is called when generating the sidebar "short" profile for a page.
234 'profile' => profile (array) record for the person from the database
235 'entry' => the (string) HTML of the generated entry
237 ### 'contact_block_end'
238 is called when formatting the block of contacts/friends on a profile sidebar has completed.
241 'contacts' => array of contacts
242 'output' => the (string) generated HTML of the contact block
245 * called during conversion of bbcode to html
246 * $b is a string converted text
249 * called during conversion of html to bbcode (e.g. remote message posting)
250 * $b is a string converted text
253 * called after building the page navigation section
254 * $b is a string HTML of nav region
257 'personal_xrd' is called prior to output of personal XRD file.
260 'user' => the user record for the person
261 'xml' => the complete XML to be output
264 * called prior to output home page content, shown to unlogged users
265 * $b is (string) HTML of section region
268 is called when editing contact details on an individual from the Contacts page.
271 'contact' => contact record (array) of target contact
272 'output' => the (string) generated HTML of the contact edit page
274 ### 'contact_edit_post'
275 * called when posting the contact edit page.
276 * $b is the $_POST array
279 * called just after DB has been opened and before session start
280 * $b is not used or passed
283 * called after HTML content functions have completed
284 * $b is (string) HTML of content div
287 'avatar_lookup' is called when looking up the avatar.
290 'size' => the size of the avatar that will be looked up
291 'email' => email to look up the avatar for
292 'url' => the (string) generated URL of the avatar
294 ### 'emailer_send_prepare'
295 'emailer_send_prepare' called from Emailer::send() before building the mime message.
296 $b is an array, params to Emailer::send()
298 'fromName' => name of the sender
299 'fromEmail' => email fo the sender
300 'replyTo' => replyTo address to direct responses
301 'toEmail' => destination email address
302 'messageSubject' => subject of the message
303 'htmlVersion' => html version of the message
304 'textVersion' => text only version of the message
305 'additionalMailHeader' => additions to the smtp mail header
308 is called before calling PHP's mail().
309 $b is an array, params to mail()
317 is called after the navigational menu is build in include/nav.php.
318 $b is an array containing $nav from nav.php.
321 is called before vars are passed to the template engine to render the page.
322 The registered function can add,change or remove variables passed to template.
325 'template' => filename of template
326 'vars' => array of vars passed to template
329 is called after the other queries have passed.
330 The registered function can add, change or remove the acl_lookup() variables.
332 'results' => array of the acl_lookup() vars
334 ### 'prepare_body_init'
335 Called at the start of prepare_body
337 'item' => item array (input/output)
339 ### 'prepare_body_content_filter'
340 Called before the HTML conversion in prepare_body. If the item matches a content filter rule set by an addon, it should
341 just add the reason to the filter_reasons element of the hook data.
343 'item' => item array (input)
344 'filter_reasons' => reasons array (input/output)
347 Called after the HTML conversion in prepare_body.
349 'item' => item array (input)
350 'html' => converted item body (input/output)
351 'is_preview' => post preview flag (input)
352 'filter_reasons' => reasons array (input)
354 ### 'prepare_body_final'
355 Called at the end of prepare_body.
357 'item' => item array (input)
358 'html' => converted item body (input/output)
360 ### 'magic_auth_success'
361 Called when a magic-auth was successful.
363 'visitor' => array with the contact record of the visitor
364 'url' => the query string
365 'session' => $_SESSION array
367 Current JavaScript hooks
370 ### 'postprocess_liveupdate'
371 Called at the end of the live update process (XmlHttpRequest)
373 Complete list of hook callbacks
376 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.
380 Addon::callHooks('init_1');
381 Addon::callHooks('app_menu', $arr);
382 Addon::callHooks('page_content_top', $a->page['content']);
383 Addon::callHooks($a->module.'_mod_init', $placeholder);
384 Addon::callHooks($a->module.'_mod_init', $placeholder);
385 Addon::callHooks($a->module.'_mod_post', $_POST);
386 Addon::callHooks($a->module.'_mod_afterpost', $placeholder);
387 Addon::callHooks($a->module.'_mod_content', $arr);
388 Addon::callHooks($a->module.'_mod_aftercontent', $arr);
389 Addon::callHooks('page_end', $a->page['content']);
393 Addon::callHooks('logged_in', $a->user);
394 Addon::callHooks('authenticate', $addon_auth);
395 Addon::callHooks('logged_in', $a->user);
397 ### include/enotify.php
399 Addon::callHooks('enotify', $h);
400 Addon::callHooks('enotify_store', $datarray);
401 Addon::callHooks('enotify_mail', $datarray);
402 Addon::callHooks('check_item_notification', $notification_data);
404 ### include/conversation.php
406 Addon::callHooks('conversation_start', $cb);
407 Addon::callHooks('render_location', $locate);
408 Addon::callHooks('display_item', $arr);
409 Addon::callHooks('display_item', $arr);
410 Addon::callHooks('item_photo_menu', $args);
411 Addon::callHooks('jot_tool', $jotplugins);
413 ### include/security.php
415 Addon::callHooks('logged_in', $a->user);
419 Addon::callHooks('contact_block_end', $arr);
420 Addon::callHooks('poke_verbs', $arr);
421 Addon::callHooks('prepare_body_init', $item);
422 Addon::callHooks('prepare_body_content_filter', $hook_data);
423 Addon::callHooks('prepare_body', $hook_data);
424 Addon::callHooks('prepare_body_final', $hook_data);
426 ### include/items.php
428 Addon::callHooks('page_info_data', $data);
430 ### mod/directory.php
432 Addon::callHooks('directory_item', $arr);
436 Addon::callHooks('personal_xrd', $arr);
440 Addon::callHooks('network_ping', $arr);
442 ### mod/parse_url.php
444 Addon::callHooks("parse_link", $arr);
448 Addon::callHooks('home_init', $ret);
452 Addon::callHooks('acl_lookup_end', $results);
456 Addon::callHooks('network_content_init', $arr);
457 Addon::callHooks('network_tabs', $arr);
459 ### mod/friendica.php
461 Addon::callHooks('about_hook', $o);
463 ### mod/subthread.php
465 Addon::callHooks('post_local_end', $arr);
469 Addon::callHooks('profile_post', $_POST);
470 Addon::callHooks('profile_edit', $arr);
474 Addon::callHooks('addon_settings_post', $_POST);
475 Addon::callHooks('connector_settings_post', $_POST);
476 Addon::callHooks('display_settings_post', $_POST);
477 Addon::callHooks('settings_post', $_POST);
478 Addon::callHooks('addon_settings', $settings_addons);
479 Addon::callHooks('connector_settings', $settings_connectors);
480 Addon::callHooks('display_settings', $o);
481 Addon::callHooks('settings_form', $o);
485 Addon::callHooks('photo_post_init', $_POST);
486 Addon::callHooks('photo_post_file', $ret);
487 Addon::callHooks('photo_post_end', $foo);
488 Addon::callHooks('photo_post_end', $foo);
489 Addon::callHooks('photo_post_end', $foo);
490 Addon::callHooks('photo_post_end', $foo);
491 Addon::callHooks('photo_post_end', intval($item_id));
492 Addon::callHooks('photo_upload_form', $ret);
496 Addon::callHooks('profile_advanced', $o);
500 Addon::callHooks('home_init', $ret);
501 Addon::callHooks("home_content", $content);
505 Addon::callHooks('post_local_end', $arr);
509 Addon::callHooks('contact_edit_post', $_POST);
510 Addon::callHooks('contact_edit', $arr);
514 Addon::callHooks('post_local_end', $arr);
518 Addon::callHooks('lockview_content', $item);
522 Addon::callHooks('uexport_options', $options);
526 Addon::callHooks('register_post', $arr);
527 Addon::callHooks('register_form', $arr);
531 Addon::callHooks('post_local_start', $_REQUEST);
532 Addon::callHooks('post_local', $datarray);
533 Addon::callHooks('post_local_end', $datarray);
537 Addon::callHooks('jot_tool', $jotplugins);
539 ### src/Network/FKOAuth1.php
541 Addon::callHooks('logged_in', $a->user);
543 ### src/Render/FriendicaSmartyEngine.php
545 Addon::callHooks("template_vars", $arr);
547 ### src/Model/Item.php
549 Addon::callHooks('post_local', $item);
550 Addon::callHooks('post_remote', $item);
551 Addon::callHooks('post_local_end', $posted_item);
552 Addon::callHooks('post_remote_end', $posted_item);
553 Addon::callHooks('tagged', $arr);
554 Addon::callHooks('post_local_end', $new_item);
556 ### src/Model/Contact.php
558 Addon::callHooks('contact_photo_menu', $args);
559 Addon::callHooks('follow', $arr);
561 ### src/Model/Profile.php
563 Addon::callHooks('profile_sidebar_enter', $profile);
564 Addon::callHooks('profile_sidebar', $arr);
565 Addon::callHooks('profile_tabs', $arr);
566 Addon::callHooks('zrl_init', $arr);
567 Addon::callHooks('magic_auth_success', $arr);
569 ### src/Model/Event.php
571 Addon::callHooks('event_updated', $event['id']);
572 Addon::callHooks("event_created", $event['id']);
574 ### src/Model/User.php
576 Addon::callHooks('register_account', $uid);
577 Addon::callHooks('remove_user', $user);
579 ### src/Content/Text/BBCode.php
581 Addon::callHooks('bbcode', $text);
582 Addon::callHooks('bb2diaspora', $text);
584 ### src/Content/Text/HTML.php
586 Addon::callHooks('html2bbcode', $message);
588 ### src/Content/Smilies.php
590 Addon::callHooks('smilie', $params);
592 ### src/Content/Feature.php
594 Addon::callHooks('isEnabled', $arr);
595 Addon::callHooks('get', $arr);
597 ### src/Content/ContactSelector.php
599 Addon::callHooks('network_to_name', $nets);
600 Addon::callHooks('gender_selector', $select);
601 Addon::callHooks('sexpref_selector', $select);
602 Addon::callHooks('marital_selector', $select);
604 ### src/Content/OEmbed.php
606 Addon::callHooks('oembed_fetch_url', $embedurl, $j);
608 ### src/Content/Nav.php
610 Addon::callHooks('page_header', $a->page['nav']);
611 Addon::callHooks('nav_info', $nav);
613 ### src/Worker/Directory.php
615 Addon::callHooks('globaldir_update', $arr);
617 ### src/Worker/Notifier.php
619 Addon::callHooks('notifier_end', $target_item);
621 ### src/Worker/Queue.php
623 Addon::callHooks('queue_predeliver', $r);
624 Addon::callHooks('queue_deliver', $params);
626 ### src/Module/Login.php
628 Addon::callHooks('authenticate', $addon_auth);
629 Addon::callHooks('login_hook', $o);
631 ### src/Module/Logout.php
633 Addon::callHooks("logging_out");
635 ### src/Object/Post.php
637 Addon::callHooks('render_location', $locate);
638 Addon::callHooks('display_item', $arr);
642 Addon::callHooks('contact_select_options', $x);
643 Addon::callHooks($a->module.'_pre_'.$selname, $arr);
644 Addon::callHooks($a->module.'_post_'.$selname, $o);
645 Addon::callHooks($a->module.'_pre_'.$selname, $arr);
646 Addon::callHooks($a->module.'_post_'.$selname, $o);
647 Addon::callHooks('jot_networks', $jotnets);
649 ### src/Core/Worker.php
651 Addon::callHooks("proc_run", $arr);
653 ### src/Util/Emailer.php
655 Addon::callHooks('emailer_send_prepare', $params);
656 Addon::callHooks("emailer_send", $hookdata);
660 Addon::callHooks('generate_map', $arr);
661 Addon::callHooks('generate_named_map', $arr);
662 Addon::callHooks('Map::getCoordinates', $arr);
664 ### src/Util/Network.php
666 Addon::callHooks('avatar_lookup', $avatar);
668 ### src/Util/ParseUrl.php
670 Addon::callHooks("getsiteinfo", $siteinfo);
672 ### src/Protocol/DFRN.php
674 Addon::callHooks('atom_feed_end', $atom);
675 Addon::callHooks('atom_feed_end', $atom);
679 callAddonHooks("postprocess_liveupdate");