X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=e3181faadb43587aa1e94533e3c2919a8e88ddb8;hb=a59c439b467b0dd307bf0d84e3d21f7b4c2d9c38;hp=8f094d16434a3b86e270806e758ce769e68f2b33;hpb=a063bb43a85afb987e6678274fdfe0b19b7b1279;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 8f094d1643..e3181faadb 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -2,6 +2,13 @@ InitializePlugin: a chance to initialize a plugin in a complete environment CleanupPlugin: a chance to cleanup a plugin at the end of a program +StartActionExecute: Right before the "prepare" call of the current Action +- $action: the current Action object +- &$args: array of arguments, referenced so you can modify the array + +EndActionExecute: Right after the "handle" call of the current Action +- $action: the current Action object + StartPrimaryNav: Showing the primary nav menu - $action: the current action @@ -35,11 +42,10 @@ EndShowUAStyles: End showing custom User-Agent links; good place to add user-age StartShowScripts: Showing JavaScript links - $action: the current action -EndShowScripts: End showing JavaScript links; good place to add custom - links like Google Analytics +EndShowScripts: End showing JavaScript links; good place to add custom links - $action: the current action -StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors) +StartShowJQueryScripts: Showing JQuery script links - $action: the current action EndShowJQueryScripts: End showing JQuery script links @@ -608,12 +614,12 @@ EndCheckPassword: After checking a username/password pair - $authenticatedUser: User object if credentials match a user, else null. StartChangePassword: Before changing a password -- $user: user +- Profile $target: The profile of the User that is changing password - $oldpassword: the user's old password - $newpassword: the desired new password EndChangePassword: After changing a password -- $user: user +- Profile $target: The profile of the User that just changed its password StartHashPassword: Generate a hashed version of the password (like a salted crypt) - &$hashed: Hashed version of the password, later put in the database @@ -1424,7 +1430,7 @@ StartNoticeListPrefill: Before pre-filling a list of notices with extra data EndNoticeListPrefill: After pre-filling a list of notices with extra data - &$notices: Notices that were pre-filled -- &$profiles: Profiles that were pre-filled +- &$profiles: Profiles that were pre-filled - $avatarSize: The avatar size for the list OtherAccountProfiles: Hook to add account profiles to a user account profile block @@ -1444,6 +1450,9 @@ StartResizeImageFile: Hook to resize an image and output it to a file. No matchi - $outpath: string with output filepath - $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h'). +FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file +- $imagefile ImageFile object which we're getting metadata for (such as animated status, width/height etc.) + StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews). - $out: HTMLOutputter class to use for outputting HTML. - $file: 'File' object which we're going to show representation for. @@ -1463,3 +1472,27 @@ StartNotifyMentioned: During notice distribution, we send notifications (email, EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned. - $stored: Notice object that is being distributed. - $mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice. + +StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home' +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- &$items: Referenced array of items in the nav (add if desired) + +EndHomeStubNavItems: +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- $items: array of menu items + +StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- $menu: The Menu object outputted as a submenu. +- $label: Localized text which represents the menu item. + +EndSubMenu: After outputting a submenu (including enclosing tags) to HTML +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- $menu: The Menu object outputted as a submenu. +- $label: Localized text which represents the menu item. + +StartDocNav: Before outputting the docs Nav +- $nav: The DoclNav widget + +EndDocNav: After outputting the docs Nav +- $nav: The DoclNav widget