1 **Friendica Addon/Plugin development**
3 This is an early specification and hook details may be subject to change.
5 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).
8 Plugin names cannot contain spaces and are used as filenames. 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".
11 Register your plugin hooks during installation.
13 register_hook($hookname, $file, $function);
15 $hookname is a string and corresponds to a known Friendica hook.
17 $file is a pathname relative to the top-level Friendica directory. This *should* be 'addon/plugin_name/plugin_name.php' in most cases.
19 $function is a string and is the name of the function which will be executed when the hook is called.
22 Your hook callback functions will be called with at least one and possibly two arguments
25 function myhook_function(&$a, &$b) {
31 If you wish to make changes to the calling data, you must declare them as
32 reference variables (with '&') during function declaration.
34 $a is the Friendica 'App' class - which contains a wealth of information
35 about the current state of Friendica, such as which module has been called,
36 configuration info, the page contents at the point the hook was invoked, profile
37 and user information, etc. It is recommeded you call this '$a' to match its usage
40 $b can be called anything you like. This is information which is specific to the hook
41 currently being processed, and generally contains information that is being immediately
42 processed or acted on that you can use, display, or alter. Remember to declare it with
43 '&' if you wish to alter it.
47 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.
49 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:
51 $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
53 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.
59 **'authenticate'** - called when a user attempts to login.
61 'username' => the supplied username
62 'password' => the supplied password
63 'authenticated' => set this to non-zero to authenticate the user.
64 'user_record' => successful authentication must also return a valid user record from the database
66 **'logged_in'** - called after a user has successfully logged in.
67 $b contains the $a->user array
70 **'display_item'** - called when formatting a post for display.
72 'item' => The item (array) details pulled from the database
73 'output' => the (string) HTML representation of this item prior to adding it to the page
75 **'post_local'** - called when a status post or comment is entered on the local system
76 $b is the item array of the information to be stored in the database
77 {Please note: body contents are bbcode - not HTML)
79 **'post_local_end'** - called when a local status post or comment has been stored on the local system
80 $b is the item array of the information which has just been stored in the database
81 {Please note: body contents are bbcode - not HTML)
83 **'post_remote'** - called when receiving a post from another source. This may also be used to post local activity or system generated messages.
84 $b is the item array of information to be stored in the database and the item
87 **'settings_form'** - called when generating the HTML for the user Settings page
88 $b is the (string) HTML of the settings page before the final '</form>' tag.
90 **'settings_post'** - called when the Settings pages are submitted.
91 $b is the $_POST array
93 **'plugin_settings'** - called when generating the HTML for the addon settings page
94 $b is the (string) HTML of the addon settings page before the final '</form>' tag.
96 **'plugin_settings_post'** - called when the Addon Settings pages are submitted.
97 $b is the $_POST array
99 **'profile_post'** - called when posting a profile page.
100 $b is the $_POST array
102 **'profile_edit'** - called prior to output of profile edit page
104 'profile' => profile (array) record from the database
105 'entry' => the (string) HTML of the generated entry
108 **'profile_advanced'** - called when the HTML is generated for the 'Advanced profile', corresponding to the 'Profile' tab within a person's profile page.
109 $b is the (string) HTML representation of the generated profile
110 (The profile array details are in $a->profile)
112 **'directory_item'** - called from the Directory page when formatting an item for display
114 'contact' => contact (array) record for the person from the database
115 'entry' => the (string) HTML of the generated entry
117 **'profile_sidebar_enter'** - called prior to generating the sidebar "short" profile for a page
118 $b is (array) the person's profile array
120 **'profile_sidebar'** - called when generating the sidebar "short" profile for a page
122 'profile' => profile (array) record for the person from the database
123 'entry' => the (string) HTML of the generated entry
125 **'contact_block_end'** - called when formatting the block of contacts/friends on a profile sidebar has completed
127 'contacts' => array of contacts
128 'output' => the (string) generated HTML of the contact block
130 **'bbcode'** - called during conversion of bbcode to html
131 $b is (string) converted text
133 **'html2bbcode'** - called during conversion of html to bbcode (e.g. remote message posting)
134 $b is (string) converted text
136 **'page_header'** - called after building the page navigation section
137 $b is (string) HTML of nav region
139 **'personal_xrd'** - called prior to output of personal XRD file.
141 'user' => the user record for the person
142 'xml' => the complete XML to be output
144 **'home_content'** - called prior to output home page content, shown to unlogged users
145 $b is (string) HTML of section region
147 **'contact_edit'** - called when editing contact details on an individual from the Contacts page
149 'contact' => contact record (array) of target contact
150 'output' => the (string) generated HTML of the contact edit page
152 **'contact_edit_post'** - called when posting the contact edit page
153 $b is the $_POST array
155 **'init_1'** - called just after DB has been opened and before session start
156 $b is not used or passed
159 **'page_end'** - called after HTML content functions have completed
160 $b is (string) HTML of content div
163 A complete list of all hook callbacks with file locations (generated 09-Nov-2011): Please see the source for details of any hooks not documented above.
165 boot.php: call_hooks('login_hook',$o);
167 boot.php: call_hooks('profile_sidebar_enter', $profile);
169 boot.php: call_hooks('profile_sidebar', $arr);
171 boot.php: call_hooks("proc_run", $arr);
173 include/contact_selectors.php: call_hooks('network_to_name', $s);
175 include/api.php: call_hooks('logged_in', $a->user);
177 include/api.php: call_hooks('logged_in', $a->user);
179 include/queue.php: call_hooks('queue_predeliver', $a, $r);
181 include/queue.php: call_hooks('queue_deliver', $a, $params);
183 include/text.php: call_hooks('contact_block_end', $arr);
185 include/text.php: call_hooks('smilie', $s);
187 include/text.php: call_hooks('prepare_body_init', $item);
189 include/text.php: call_hooks('prepare_body', $prep_arr);
191 include/text.php: call_hooks('prepare_body_final', $prep_arr);
193 include/nav.php: call_hooks('page_header', $a->page['nav']);
195 include/auth.php: call_hooks('authenticate', $addon_auth);
197 include/auth.php: call_hooks('logged_in', $a->user);
199 include/bbcode.php: call_hooks('bbcode',$Text);
201 include/oauth.php: call_hooks('logged_in', $a->user);
203 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
205 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
207 include/acl_selectors.php: call_hooks('contact_select_options', $x);
209 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
211 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
213 include/acl_selectors.php: call_hooks($a->module . '_pre_' . $selname, $arr);
215 include/acl_selectors.php: call_hooks($a->module . '_post_' . $selname, $o);
217 include/notifier.php: call_hooks('notifier_normal',$target_item);
219 include/notifier.php: call_hooks('notifier_end',$target_item);
221 include/items.php: call_hooks('atom_feed', $atom);
223 include/items.php: call_hooks('atom_feed_end', $atom);
225 include/items.php: call_hooks('atom_feed_end', $atom);
227 include/items.php: call_hooks('parse_atom', $arr);
229 include/items.php: call_hooks('post_remote',$arr);
231 include/items.php: call_hooks('atom_author', $o);
233 include/items.php: call_hooks('atom_entry', $o);
235 include/bb2diaspora.php: call_hooks('bb2diaspora',$Text);
237 include/cronhooks.php: call_hooks('cron', $d);
239 include/html2bbcode.php: call_hooks('html2bbcode', $text);
241 include/Contact.php: call_hooks('contact_photo_menu', $args);
243 include/conversation.php: call_hooks('display_item', $arr);
245 include/conversation.php: call_hooks('display_item', $arr);
247 include/conversation.php: call_hooks('item_photo_menu', $args);
249 include/conversation.php: call_hooks('jot_tool', $jotplugins);
251 include/conversation.php: call_hooks('jot_networks', $jotnets);
253 include/plugin.php:if(! function_exists('call_hooks')) {
255 include/plugin.php:function call_hooks($name, &$data = null) {
257 index.php: call_hooks('init_1');
259 index.php:call_hooks('app_menu', $arr);
261 index.php:call_hooks('page_end', $a->page['content']);
263 mod/photos.php: call_hooks('photo_post_init', $_POST);
265 mod/photos.php: call_hooks('photo_post_file',$ret);
267 mod/photos.php: call_hooks('photo_post_end',$foo);
269 mod/photos.php: call_hooks('photo_post_end',$foo);
271 mod/photos.php: call_hooks('photo_post_end',$foo);
273 mod/photos.php: call_hooks('photo_post_end',intval($item_id));
275 mod/photos.php: call_hooks('photo_upload_form',$ret);
277 mod/friendica.php: call_hooks('about_hook', $o);
279 mod/editpost.php: call_hooks('jot_tool', $jotplugins);
281 mod/editpost.php: call_hooks('jot_networks', $jotnets);
283 mod/parse_url.php: call_hooks('parse_link', $arr);
285 mod/home.php: call_hooks("home_content",$o);
287 mod/contacts.php: call_hooks('contact_edit_post', $_POST);
289 mod/contacts.php: call_hooks('contact_edit', $arr);
291 mod/settings.php: call_hooks('plugin_settings_post', $_POST);
293 mod/settings.php: call_hooks('connector_settings_post', $_POST);
295 mod/settings.php: call_hooks('settings_post', $_POST);
297 mod/settings.php: call_hooks('plugin_settings', $settings_addons);
299 mod/settings.php: call_hooks('connector_settings', $settings_connectors);
301 mod/settings.php: call_hooks('settings_form',$o);
303 mod/register.php: call_hooks('register_account', $newuid);
305 mod/like.php: call_hooks('post_local_end', $arr);
307 mod/xrd.php: call_hooks('personal_xrd', $arr);
309 mod/item.php: call_hooks('post_local_start', $_POST);
311 mod/item.php: call_hooks('post_local',$datarray);
313 mod/item.php: call_hooks('post_local_end', $datarray);
315 mod/profile.php: call_hooks('profile_advanced',$o);
317 mod/profiles.php: call_hooks('profile_post', $_POST);
319 mod/profiles.php: call_hooks('profile_edit', $arr);
321 mod/tagger.php: call_hooks('post_local_end', $arr);
323 mod/cb.php: call_hooks('cb_init');
325 mod/cb.php: call_hooks('cb_post', $_POST);
327 mod/cb.php: call_hooks('cb_afterpost');
329 mod/cb.php: call_hooks('cb_content', $o);
331 mod/directory.php: call_hooks('directory_item', $arr);