addon/README

   1 Friendika Addon/Plugin development
   2
   3 This is an early specification and hook details may be subject to change.
   4
   5 Please see the sample addon 'randplace' for a working example of using these features.
   6
   7
   8 You must register plugins with the system in the .htconfig.php file.
   9
  10 $a->config['system']['addon'] = 'plugin1name, plugin2name, another_name';
  11
  12 Plugin names cannot contain spaces and are used as filenames.
  13
  14
  15 Register your plugin hooks during installation.
  16
  17         register_hook($hookname, $file, $function);
  18
  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.
  24
  25
  26 Your hook functions will be called with at least one and possibly two arguments
  27
  28         function myhook_function(&$a, &$b) {
  29
  30
  31         }
  32
  33 If you wish to make changes to the calling data, you must declare them as
  34 reference variables (with '&') during function declaration.
  35
  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
  40 elsewhere.
  41
  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.
  46
  47
  48 Current hooks:
  49
  50 'authenticate' - called when a user attempts to login.
  51         $b is an array
  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
  56
  57
  58 'logged_in' - called after a user has successfully logged in.
  59         $b contains the $a->user array
  60
  61
  62 'display_item' - called when formatting a post for display.
  63         $b is an array
  64                 'item' => The item (array) details pulled from the database
  65                 'output' => the (string) HTML representation of this item prior to adding it
  66                         to the page
  67
  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)
  71
  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)
  75
  76
  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
  80         body is bbcode.
  81
  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.
  84
  85 'plugin_settings' - called when generating the HTML for the addon settings page
  86         $b is the (string) HTML of the addon settings page before the final '</form>' tag.
  87
  88 'settings_post' - called when the Settings and Addon Settings pages are submitted.
  89         $b is the $_POST array
  90
  91 'profile_advanced' - called when the HTML is generated for the 'Advanced profile',
  92         corresponding to the 'Profile' tab within a person's profile page.
  93         $b is the (string) HTML representation of the generated profile
  94
  95 'directory_item' - called from the Directory page when formatting an item for display
  96         $b is an array
  97                 'contact' => contact (array) record for the person from the database
  98                 'entry' => the (string) HTML of the generated entry
  99
 100 'profile_sidebar' - called when generating the sidebar "short" profile for a page
 101         $b is the (string) generated HTML of the entry
 102                 (The profile array details are in $a->profile)
 103
 104 'contact_block_end' - called when formatting the block of contacts/friends on a
 105         profile sidebar has completed
 106         $b is an array
 107                 'contacts' => contact array of entries
 108                 'output' => the (string) generated HTML of the contact block
 109
 110 'bbcode' - called during conversion of bbcode to html
 111         $b is (string) converted text
 112
 113 'html2bbcode' - called during conversion of html to bbcode (e.g. remote message posting)
 114         $b is (string) converted text
 115
 116
 117 'page_header' - called after building the page navigation section
 118         $b is (string) HTML of nav region
 119
 120
 121 *** = subject to change
 122
 123
 124
 125
 126
 127 Not yet documented:
 128
 129 'atom_feed'
 130
 131 'atom_feed_end'
 132
 133 'parse_atom'
 134
 135 'atom_author'
 136
 137 'atom_entry'
 138
 139 'parse_link'
 140
 141
 142
 143
 144