Merge branch 'master' of git://github.com/friendika/friendika

[friendica.git] / addon / README

diff --git a/addon/README b/addon/README
index 84f8569248c3a09eb5b7a3aa6f9a3478e63114e6..83407d6a17e7db9efa3d756b75baa91d3af6d9e8 100644 (file)
--- a/addon/README
+++ b/addon/README
@@ -52,6 +52,8 @@ Current hooks:
                'username' => the supplied username
                'password' => the supplied password
                'authenticated' => set this to non-zero to authenticate the user.
+               'user_record' => successful authentication must also return a valid user record from the database
+
 
 'logged_in' - called after a user has successfully logged in.
        $b contains the $a->user array
@@ -67,6 +69,11 @@ Current hooks:
        $b is the item array of the information to be stored in the database
                {Please note: body contents are bbcode - not HTML)
 
+'post_local_end' - called when a local status post or comment has been stored on the local system
+       $b is the item array of the information which has just been stored in the database
+               {Please note: body contents are bbcode - not HTML)
+
+
 'post_remote' - called when receiving a post from another source. This may also be used
        to post local activity or system generated messages.
        $b is the item array of information to be stored in the database and the item
@@ -94,10 +101,28 @@ Current hooks:
        $b is the (string) generated HTML of the entry
                (The profile array details are in $a->profile)
 
-'contact_block_end' - called when displaying the block of contacts/friends on a 
-       profile sidebar
-***    $b is the (string) generated HTML of the contact block
+'contact_block_end' - called when formatting the block of contacts/friends on a 
+       profile sidebar has completed
+       $b is an array
+               'contacts' => contact array of entries
+               'output' => the (string) generated HTML of the contact block
+
+'bbcode' - called during conversion of bbcode to html
+       $b is (string) converted text
 
+'html2bbcode' - called during conversion of html to bbcode (e.g. remote message posting)
+       $b is (string) converted text
+
+
+'page_header' - called after building the page navigation section
+       $b is (string) HTML of nav region
+
+
+'personal_xrd' - called prior to output of personal XRD file.
+       $b is an array
+               'user' => the user record for the person
+               'xml' => the complete XML to be output
+ 
 
 *** = subject to change