X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=addon%2FREADME;h=fb1c6340a50cf1d4ba1bc3ac0067575840e64a0e;hb=dc15e8640de0fcd77bf91b97aee6f890b34ba6cb;hp=8d5088f7837d73bbae283a5e3ddc02d3e5772db2;hpb=2abdfb462a34a5c469efe12243e2a91d3fa39a03;p=friendica.git

diff --git a/addon/README b/addon/README
index 8d5088f783..fb1c6340a5 100644
--- 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
@@ -75,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
@@ -90,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
@@ -100,6 +122,43 @@ Current hooks:
 		'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
+ 
+
+'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
 
@@ -109,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' ***