1 Friendica Addon/Plugin development
2 ==========================
4 Please see the sample addon 'randplace' for a working example of using some of these features. The facebook addon provides an example of integrating both "addon" and "module" functionality. Addons work by intercepting event hooks - which must be registered. Modules work by intercepting specific page requests (by URL path).
7 Plugin names cannot contain spaces or other punctuation and are used as filenames and function names. You may supply a "friendly" name within the comment block. Each addon must contain both an install and an uninstall function based on the addon/plugin name. For instance "plugin1name_install()". These two functions take no arguments and are usually responsible for registering (and unregistering) event hooks that your plugin will require. The install and uninstall functions will also be called (i.e. re-installed) if the plugin changes after installation - therefore your uninstall should not destroy data and install should consider that data may already exist. Future extensions may provide for "setup" amd "remove".
9 Plugins should contain a comment block with the four following parameters:
12 * Name: My Great Plugin
13 * Description: This is what my plugin does. It's really cool
15 * Author: John Q. Public <john@myfriendicasite.com>
21 Register your plugin hooks during installation.
23 register_hook($hookname, $file, $function);
25 $hookname is a string and corresponds to a known Friendica hook.
27 $file is a pathname relative to the top-level Friendica directory. This *should* be 'addon/plugin_name/plugin_name.php' in most cases.
29 $function is a string and is the name of the function which will be executed when the hook is called.
32 Your hook callback functions will be called with at least one and possibly two arguments
35 function myhook_function(&$a, &$b) {
41 If you wish to make changes to the calling data, you must declare them as
42 reference variables (with '&') during function declaration.
44 $a is the Friendica 'App' class - which contains a wealth of information
45 about the current state of Friendica, such as which module has been called,
46 configuration info, the page contents at the point the hook was invoked, profile
47 and user information, etc. It is recommeded you call this '$a' to match its usage
50 $b can be called anything you like. This is information which is specific to the hook
51 currently being processed, and generally contains information that is being immediately
52 processed or acted on that you can use, display, or alter. Remember to declare it with
53 '&' if you wish to alter it.
58 Plugins/addons may also act as "modules" and intercept all page requests for a given URL path. In order for a plugin to act as a module it needs to define a function "plugin_name_module()" which takes no arguments and need not do anything.
60 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. These are parsed into an array $a->argv, with a corresponding $a->argc indicating the number of URL components. 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). This will include:
62 $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
64 Your module functions will often contain the function plugin_name_content(&$a), which defines and returns the page body content. They may also contain plugin_name_post(&$a) which is called before the _content function and typically handles the results of POST forms. You may also have plugin_name_init(&$a) which is called very early on and often does module initialisation.
70 If your plugin need some template, you can use Friendica template system. Friendica use [smarty3](http://www.smarty.net/) as template engine.
72 Put your tpl files in *templates/* subfolder of your plugin.
74 In your code, like in function plugin_name_content(), load template file and execute it passing needed values:
76 # load template file. first argument is the template name,
77 # second is the plugin path relative to friendica top folder
78 $tpl = get_markup_template('mytemplate.tpl', 'addon/plugin_name/');
80 # apply template. first argument is the loaded template,
81 # second an array of 'name'=>'values' to pass to template
82 $output = replace_macros($tpl,array(
83 'title' => 'My beautifull plugin',
86 See also wiki page [Quick Template Guide](https://github.com/friendica/friendica/wiki/Quick-Template-Guide)
91 **'authenticate'** - called when a user attempts to login.
93 'username' => the supplied username
94 'password' => the supplied password
95 'authenticated' => set this to non-zero to authenticate the user.
96 'user_record' => successful authentication must also return a valid user record from the database
98 **'logged_in'** - called after a user has successfully logged in.
99 $b contains the $a->user array
102 **'display_item'** - called when formatting a post for display.
104 'item' => The item (array) details pulled from the database
105 'output' => the (string) HTML representation of this item prior to adding it to the page
107 **'post_local'** - called when a status post or comment is entered on the local system
108 $b is the item array of the information to be stored in the database
109 {Please note: body contents are bbcode - not HTML)
111 **'post_local_end'** - called when a local status post or comment has been stored on the local system
112 $b is the item array of the information which has just been stored in the database
113 {Please note: body contents are bbcode - not HTML)
115 **'post_remote'** - called when receiving a post from another source. This may also be used to post local activity or system generated messages.
116 $b is the item array of information to be stored in the database and the item
119 **'settings_form'** - called when generating the HTML for the user Settings page
120 $b is the (string) HTML of the settings page before the final '</form>' tag.
122 **'settings_post'** - called when the Settings pages are submitted.
123 $b is the $_POST array
125 **'plugin_settings'** - called when generating the HTML for the addon settings page
126 $b is the (string) HTML of the addon settings page before the final '</form>' tag.
128 **'plugin_settings_post'** - called when the Addon Settings pages are submitted.
129 $b is the $_POST array
131 **'profile_post'** - called when posting a profile page.
132 $b is the $_POST array
134 **'profile_edit'** - called prior to output of profile edit page
136 'profile' => profile (array) record from the database
137 'entry' => the (string) HTML of the generated entry
140 **'profile_advanced'** - called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page.
141 $b is the (string) HTML representation of the generated profile
142 (The profile array details are in $a->profile)
144 **'directory_item'** - called from the Directory page when formatting an item for display
146 'contact' => contact (array) record for the person from the database
147 'entry' => the (string) HTML of the generated entry
149 **'profile_sidebar_enter'** - called prior to generating the sidebar "short" profile for a page
150 $b is (array) the person's profile array
152 **'profile_sidebar'** - called when generating the sidebar "short" profile for a page
154 'profile' => profile (array) record for the person from the database
155 'entry' => the (string) HTML of the generated entry
157 **'contact_block_end'** - called when formatting the block of contacts/friends on a profile sidebar has completed
159 'contacts' => array of contacts
160 'output' => the (string) generated HTML of the contact block
162 **'bbcode'** - called during conversion of bbcode to html
163 $b is (string) converted text
165 **'html2bbcode'** - called during conversion of html to bbcode (e.g. remote message posting)
166 $b is (string) converted text
168 **'page_header'** - called after building the page navigation section
169 $b is (string) HTML of nav region
171 **'personal_xrd'** - called prior to output of personal XRD file.
173 'user' => the user record for the person
174 'xml' => the complete XML to be output
176 **'home_content'** - called prior to output home page content, shown to unlogged users
177 $b is (string) HTML of section region
179 **'contact_edit'** - called when editing contact details on an individual from the Contacts page
181 'contact' => contact record (array) of target contact
182 'output' => the (string) generated HTML of the contact edit page
184 **'contact_edit_post'** - called when posting the contact edit page
185 $b is the $_POST array
187 **'init_1'** - called just after DB has been opened and before session start
188 $b is not used or passed
190 **'page_end'** - called after HTML content functions have completed
191 $b is (string) HTML of content div
193 **'avatar_lookup'** - called when looking up the avatar
195 'size' => the size of the avatar that will be looked up
196 'email' => email to look up the avatar for
197 'url' => the (string) generated URL of the avatar
200 A complete list of all hook callbacks with file locations (generated 14-Feb-2012): Please see the source for details of any hooks not documented above.
203 boot.php: call_hooks('login_hook',$o);
205 boot.php: call_hooks('profile_sidebar_enter', $profile);
207 boot.php: call_hooks('profile_sidebar', $arr);
209 boot.php: call_hooks("proc_run", $arr);
211 include/contact_selectors.php: call_hooks('network_to_name', $nets);
213 include/api.php: call_hooks('logged_in', $a->user);
215 include/api.php: call_hooks('logged_in', $a->user);
217 include/queue.php: call_hooks('queue_predeliver', $a, $r);
219 include/queue.php: call_hooks('queue_deliver', $a, $params);
221 include/text.php: call_hooks('contact_block_end', $arr);
223 include/text.php: call_hooks('smilie', $s);
225 include/text.php: call_hooks('prepare_body_init', $item);
227 include/text.php: call_hooks('prepare_body', $prep_arr);
229 include/text.php: call_hooks('prepare_body_final', $prep_arr);
231 include/nav.php: call_hooks('page_header', $a->page['nav']);
233 include/auth.php: call_hooks('authenticate', $addon_auth);
235 include/bbcode.php: call_hooks('bbcode',$Text);
237 include/oauth.php: call_hooks('logged_in', $a->user);
239 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
241 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
243 include/acl_selectors.php: call_hooks('contact_select_options', $x);
245 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
247 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
249 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
251 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
253 include/notifier.php: call_hooks('notifier_normal',$target_item);
255 include/notifier.php: call_hooks('notifier_end',$target_item);
257 include/items.php: call_hooks('atom_feed', $atom);
259 include/items.php: call_hooks('atom_feed_end', $atom);
261 include/items.php: call_hooks('atom_feed_end', $atom);
263 include/items.php: call_hooks('parse_atom', $arr);
265 include/items.php: call_hooks('post_remote',$arr);
267 include/items.php: call_hooks('atom_author', $o);
269 include/items.php: call_hooks('atom_entry', $o);
271 include/bb2diaspora.php: call_hooks('bb2diaspora',$Text);
273 include/cronhooks.php: call_hooks('cron', $d);
275 include/security.php: call_hooks('logged_in', $a->user);
277 include/html2bbcode.php: call_hooks('html2bbcode', $text);
279 include/Contact.php: call_hooks('remove_user',$r[0]);
281 include/Contact.php: call_hooks('contact_photo_menu', $args);
283 include/conversation.php: call_hooks('conversation_start',$cb);
285 include/conversation.php: call_hooks('render_location',$locate);
287 include/conversation.php: call_hooks('display_item', $arr);
289 include/conversation.php: call_hooks('render_location',$locate);
291 include/conversation.php: call_hooks('display_item', $arr);
293 include/conversation.php: call_hooks('item_photo_menu', $args);
295 include/conversation.php: call_hooks('jot_tool', $jotplugins);
297 include/conversation.php: call_hooks('jot_networks', $jotnets);
299 include/plugin.php:if(! function_exists('call_hooks')) {
301 include/plugin.php:function call_hooks($name, &$data = null) {
303 index.php: call_hooks('init_1');
305 index.php:call_hooks('app_menu', $arr);
307 index.php:call_hooks('page_end', $a->page['content']);
309 mod/photos.php: call_hooks('photo_post_init', $_POST);
311 mod/photos.php: call_hooks('photo_post_file',$ret);
313 mod/photos.php: call_hooks('photo_post_end',$foo);
315 mod/photos.php: call_hooks('photo_post_end',$foo);
317 mod/photos.php: call_hooks('photo_post_end',$foo);
319 mod/photos.php: call_hooks('photo_post_end',intval($item_id));
321 mod/photos.php: call_hooks('photo_upload_form',$ret);
323 mod/friendica.php: call_hooks('about_hook', $o);
325 mod/editpost.php: call_hooks('jot_tool', $jotplugins);
327 mod/editpost.php: call_hooks('jot_networks', $jotnets);
329 mod/parse_url.php: call_hooks('parse_link', $arr);
331 mod/home.php: call_hooks('home_init',$ret);
333 mod/home.php: call_hooks("home_content",$o);
335 mod/contacts.php: call_hooks('contact_edit_post', $_POST);
337 mod/contacts.php: call_hooks('contact_edit', $arr);
339 mod/settings.php: call_hooks('plugin_settings_post', $_POST);
341 mod/settings.php: call_hooks('connector_settings_post', $_POST);
343 mod/settings.php: call_hooks('settings_post', $_POST);
345 mod/settings.php: call_hooks('plugin_settings', $settings_addons);
347 mod/settings.php: call_hooks('connector_settings', $settings_connectors);
349 mod/settings.php: call_hooks('settings_form',$o);
351 mod/register.php: call_hooks('register_account', $newuid);
353 mod/like.php: call_hooks('post_local_end', $arr);
355 mod/xrd.php: call_hooks('personal_xrd', $arr);
357 mod/item.php: call_hooks('post_local_start', $_REQUEST);
359 mod/item.php: call_hooks('post_local',$datarray);
361 mod/item.php: call_hooks('post_local_end', $datarray);
363 mod/profile.php: call_hooks('profile_advanced',$o);
365 mod/profiles.php: call_hooks('profile_post', $_POST);
367 mod/profiles.php: call_hooks('profile_edit', $arr);
369 mod/tagger.php: call_hooks('post_local_end', $arr);
371 mod/cb.php: call_hooks('cb_init');
373 mod/cb.php: call_hooks('cb_post', $_POST);
375 mod/cb.php: call_hooks('cb_afterpost');
377 mod/cb.php: call_hooks('cb_content', $o);
379 mod/directory.php: call_hooks('directory_item', $arr);