1 Friendika 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 these features.
8 You must register plugins with the system in the .htconfig.php file.
10 $a->config['system']['addon'] = 'plugin1name, plugin2name, another_name';
12 Plugin names cannot contain spaces and are used as filenames.
15 Register your plugin hooks during installation.
17 register_hook($hookname, $file, $function);
19 $hookname is a string and corresponds to a known Friendika hook
20 $file is a pathname relative to the top-level Friendika directory.
21 This *should* be 'addon/plugin_name/plugin_name.php' in most cases.
22 $function is a string and is the name of the function which will be executed
23 when the hook is called.
26 Your hook functions will be called with at least one and possibly two arguments
28 function myhook_function(&$a, &$b) {
33 If you wish to make changes to the calling data, you must declare them as
34 reference variables (with '&') during function declaration.
36 $a is the Friendika 'App' class - which contains a wealth of information
37 about the current state of Friendika, such as which module has been called,
38 configuration info, the page contents at the point the hook was invoked, profile
39 and user information, etc. It is recommeded you call this '$a' to match its usage
42 $b can be called anything you like. This is information which is specific to the hook
43 currently being processed, and generally contains information that is being immediately
44 processed or acted on that you can use, display, or alter. Remember to declare it with
45 '&' if you wish to alter it.
50 'authenticate' - called when a user attempts to login.
52 'username' => the supplied username
53 'password' => the supplied password
54 'authenticated' => set this to non-zero to authenticate the user.
55 'user_record' => successful authentication must also return a valid user record from the database
58 'logged_in' - called after a user has successfully logged in.
59 $b contains the $a->user array
62 'display_item' - called when formatting a post for display.
64 'item' => The item (array) details pulled from the database
65 'output' => the (string) HTML representation of this item prior to adding it
68 'post_local' - called when a status post or comment is entered on the local system
69 $b is the item array of the information to be stored in the database
70 {Please note: body contents are bbcode - not HTML)
72 'post_local_end' - called when a local status post or comment has been stored on the local system
73 $b is the item array of the information which has just been stored in the database
74 {Please note: body contents are bbcode - not HTML)
77 'post_remote' - called when receiving a post from another source. This may also be used
78 to post local activity or system generated messages.
79 $b is the item array of information to be stored in the database and the item
82 'settings_form' - called when generating the HTML for the user Settings page
83 $b is the (string) HTML of the settings page before the final '</form>' tag.
85 'settings_post' - called when the Settings pages are submitted.
86 $b is the $_POST array
88 'plugin_settings' - called when generating the HTML for the addon settings page
89 $b is the (string) HTML of the addon settings page before the final '</form>' tag.
91 'plugin_settings_post' - called when the Addon Settings pages are submitted.
92 $b is the $_POST array
94 'profile_advanced' - called when the HTML is generated for the 'Advanced profile',
95 corresponding to the 'Profile' tab within a person's profile page.
96 $b is the (string) HTML representation of the generated profile
98 'directory_item' - called from the Directory page when formatting an item for display
100 'contact' => contact (array) record for the person from the database
101 'entry' => the (string) HTML of the generated entry
103 'profile_sidebar' - called when generating the sidebar "short" profile for a page
104 $b is the (string) generated HTML of the entry
105 (The profile array details are in $a->profile)
107 'contact_block_end' - called when formatting the block of contacts/friends on a
108 profile sidebar has completed
110 'contacts' => contact array of entries
111 'output' => the (string) generated HTML of the contact block
113 'bbcode' - called during conversion of bbcode to html
114 $b is (string) converted text
116 'html2bbcode' - called during conversion of html to bbcode (e.g. remote message posting)
117 $b is (string) converted text
120 'page_header' - called after building the page navigation section
121 $b is (string) HTML of nav region
124 'personal_xrd' - called prior to output of personal XRD file.
126 'user' => the user record for the person
127 'xml' => the complete XML to be output
130 'home_content' - called prior to output home page content, shown to unlogged users
131 $b is (string) HTML of section region
134 *** = subject to change