Merge pull request #132 from fabrixxm/master

[friendica.git] / addon / README

diff --git a/addon/README b/addon/README
index 83407d6a17e7db9efa3d756b75baa91d3af6d9e8..fb1c6340a50cf1d4ba1bc3ac0067575840e64a0e 100644 (file)
--- a/addon/README
+++ b/addon/README
@@ -82,12 +82,23 @@ Current hooks:
 'settings_form' - called when generating the HTML for the user Settings page
        $b is the (string) HTML of the settings page before the final '</form>' tag.
 
+'settings_post' - called when the Settings pages are submitted.
+       $b is the $_POST array
+
 'plugin_settings' - called when generating the HTML for the addon settings page
        $b is the (string) HTML of the addon settings page before the final '</form>' tag.
 
-'settings_post' - called when the Settings and Addon Settings pages are submitted.
+'plugin_settings_post' - called when the Addon Settings pages are submitted.
+       $b is the $_POST array
+
+'profile_post' - called when posting a profile page.
        $b is the $_POST array
 
+'profile_edit' - called prior to output of profile edit page
+       $b is array
+               'profile' => profile (array) record from the database
+               'entry' => the (string) HTML of the generated entry
+
 'profile_advanced' - called when the HTML is generated for the 'Advanced profile', 
        corresponding to the 'Profile' tab within a person's profile page.
        $b is the (string) HTML representation of the generated profile
@@ -97,9 +108,13 @@ Current hooks:
                'contact' => contact (array) record for the person from the database
                'entry' => the (string) HTML of the generated entry 
 
+'profile_sidebar_enter' - called prior to generating the sidebar "short" profile for a page
+       $b is (array) the person's profile array
+
 'profile_sidebar' - called when generating the sidebar "short" profile for a page
-       $b is the (string) generated HTML of the entry
-               (The profile array details are in $a->profile)
+       $b is an array
+               'profile' => profile (array) record for the person from the database
+               'entry' => the (string) HTML of the generated entry
 
 'contact_block_end' - called when formatting the block of contacts/friends on a 
        profile sidebar has completed
@@ -124,6 +139,27 @@ Current hooks:
                'xml' => the complete XML to be output
  
 
+'home_content' - called prior to output home page content, shown to unlogged users
+       $b is (string) HTML of section region
+
+'contact_edit' - called when editing contact details on an individual from the Contacts page
+       $b is (array)
+               'contact' => contact record (array) of target contact
+               'output' => the (string) generated HTML of the contact edit page
+
+'contact_edit_post' - called when posting the contact edit page
+       $b is the $_POST array
+
+'init_1' - called just after DB has been opened and before session start
+       $b is not used or passed
+
+'page_end' - called after HTML content functions have completed
+    $b is (string) HTML of content div
+
+'jot_plugin' - add tools to jot toolbar
+  $b is (string) HTML for tool icon
+
+
 *** = subject to change
 
 
@@ -132,17 +168,17 @@ Current hooks:
 
 Not yet documented:
 
-'atom_feed'
+'atom_feed' ***
 
-'atom_feed_end'
+'atom_feed_end' ***
 
-'parse_atom'
+'parse_atom' ***
 
-'atom_author'
+'atom_author' ***
 
-'atom_entry'
+'atom_entry' ***
 
-'parse_link'
+'parse_link' ***