X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=05d172585549f413a4be6e3ed457ad38044f7d80;hb=a08c76a4342cfb4b3d772f6880ba0b8f3153b246;hp=aed3dd9c5a451ee55185e8f6deb4ad204e8c7471;hpb=dac8d103e69deb63c7eafe16286f23a66034d967;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index aed3dd9c5a..05d1725855 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -1,5 +1,4 @@ -InitializePlugin: a chance to initialize a plugin in a complete - environment +InitializePlugin: a chance to initialize a plugin in a complete environment CleanupPlugin: a chance to cleanup a plugin at the end of a program @@ -15,6 +14,30 @@ StartSecondaryNav: Showing the secondary nav menu EndSecondaryNav: At the end of the secondary nav menu - $action: the current action +StartShowStyles: Showing Style links; good place to add UA style resets +- $action: the current action + +EndShowStyles: End showing Style links; good place to add custom styles +- $action: the current action + +StartShowStatusNetStyles: Showing StatusNet Style links +- $action: the current action + +EndShowStatusNetStyles: End showing StatusNet Style links; good place to add handheld or JavaScript dependant styles +- $action: the current action + +StartShowLaconicaStyles: backwards compatibility; deprecated +- $action: the current action + +EndShowLaconicaStyles: backwards compatibility; deprecated +- $action: the current action + +StartShowUAStyles: Showing custom User-Agent style links +- $action: the current action + +EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles +- $action: the current action + StartShowScripts: Showing JavaScript links - $action: the current action @@ -28,10 +51,16 @@ StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Go EndShowJQueryScripts: End showing JQuery script links - $action: the current action -StartShowLaconicaScripts: Showing Laconica script links (use this to link to a CDN or something) +StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something) - $action: the current action -EndShowLaconicaScripts: End showing Laconica script links +EndShowStatusNetScripts: End showing StatusNet script links +- $action: the current action + +StartShowLaconicaScripts: backwards compatibility; deprecated +- $action: the current action + +EndShowLaconicaScripts: backwards compatibility; deprecated - $action: the current action StartShowSections: Start the list of sections in the sidebar @@ -58,3 +87,163 @@ StartShowContentBlock: Showing before the content container EndShowContentBlock: Showing after the content container - $action: the current action +StartNoticeSave: before inserting a notice (good place for content filters) +- $notice: notice being saved (no ID or URI) + +EndNoticeSave: after inserting a notice and related code +- $notice: notice that was saved (with ID and URI) + +StartShowLocalNavBlock: Showing the local nav menu +- $action: the current action + +EndShowLocalNavBlock: At the end of the local nav menu +- $action: the current action + +StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties +- $action: the current action + +EndShowHTML: Showing after the html element +- $action: the current action + +StartPublicGroupNav: Showing the public group nav menu +- $action: the current action + +EndPublicGroupNav: At the end of the public group nav menu +- $action: the current action + +StartSubGroupNav: Showing the subscriptions group nav menu +- $action: the current action + +EndSubGroupNav: At the end of the subscriptions group nav menu +- $action: the current action + +RouterInitialized: After the router instance has been initialized +- $m: the Net_URL_Mapper that has just been set up + +StartLogout: Before logging out +- $action: the logout action + +EndLogout: After logging out +- $action: the logout action + +ArgsInitialized: After the argument array has been initialized +- $args: associative array of arguments, can be modified + +StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location) +- $action: the current action + +EndAddressData: At the end of
+- $action: the current action + +StartLoginGroupNav: Before showing the login and register navigation menu +- $action: the current action + +EndLoginGroupNav: After showing the login and register navigation menu +- $action: the current action + +StartAccountSettingsNav: Before showing the account settings menu +- $action: the current action + +EndAccountSettingsNav: After showing the account settings menu +- $action: the current action + +Autoload: When trying to autoload a class +- $cls: the class being sought. A plugin might require_once the file for the class. + +SensitiveAction: determines if an action is 'sensitive' and should use SSL +- $action: name of the action, like 'login' +- $sensitive: flag for whether this is a sensitive action + +LoginAction: determines if an action is a 'login' action (OK for public view in private mode) +- $action: name of the action, like 'register' +- $login: flag for whether this is a login action + +StartShowHead: called before showing the element and children +- $action: action object being show + +EndShowHead: called after showing the element (and ) +- $action: action object being shown + +StartShowBody: called before showing the element and children +- $action: action object being shown + +EndShowBody: called after showing the element (and ) +- $action: action object being shown + +StartHeadChildren: called before showing the children of element (after tag) +- $action: action object being shown + +EndHeadChildren: called after showing the children of element (before ) +- $action: action object being shown + +StartPersonalGroupNav: beginning of personal group nav menu +- $action: action object being shown + +EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item) +- $action: action object being shown + +StartEndHTML: just before the tag +- $action: action object being shown + +EndEndHTML: just after the tag +- $action: action object being shown + +StartShowDesign: just before showing a site, user, or group design +- $action: action object being shown + +EndShowDesign: just after showing a site, user, or group design +- $action: action object being shown + +StartShowExportData: just before showing the
with export data (feeds) +- $action: action object being shown + +EndShowExportData: just after showing the
with export data (feeds) +- $action: action object being shown + +StartShowPageNotice: just before showing the page notice (instructions or error) +- $action: action object being shown + +EndShowPageNotice: just after showing the page notice (instructions or error) +- $action: action object being shown + +StartShowPageTitle: just before showing the main h1 title of a page (only for registration) +- $action: action object being shown + +StartProfileFormData: just before showing text entry fields on profile settings page +- $action: action object being shown + +EndProfileFormData: just after showing text entry fields on profile settings page +- $action: action object being shown + +StartProfileSaveForm: before starting to save a profile settings form +- $action: action object being shown + +EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!) +- $action: action object being shown + +StartRegistrationFormData: just before showing text entry fields on registration page +- $action: action object being shown + +EndRegistrationFormData: just after showing text entry fields on registration page +- $action: action object being shown + +StartRegistrationTry: before validating and saving a new user +- $action: action object being shown + +EndRegistrationTry: after saving a new user (note: no profile or user object!) +- $action: action object being shown + +StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes +- $qm: empty queue manager to set + +RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login) +- $action: action object being shown +- $user: current user + +StartLoadDoc: before loading a help doc (hook this to show your own documentation) +- $title: title of the document +- $output: HTML output to show + +EndLoadDoc: after loading a help doc (hook this to modify other documentation) +- $title: title of the document +- $output: HTML output to show