EVENTS.txt 8.73 KB
Newer Older
1
InitializePlugin: a chance to initialize a plugin in a complete environment
2 3 4

CleanupPlugin: a chance to cleanup a plugin at the end of a program

5 6 7 8 9 10 11 12 13 14 15
StartPrimaryNav: Showing the primary nav menu
- $action: the current action

EndPrimaryNav: At the end of the primary nav menu
- $action: the current action

StartSecondaryNav: Showing the secondary nav menu
- $action: the current action

EndSecondaryNav: At the end of the secondary nav menu
- $action: the current action
16

17 18 19 20 21 22
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

23
StartShowStatusNetStyles: Showing StatusNet Style links
24 25
- $action: the current action

26
EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
27 28
- $action: the current action

29 30 31 32
StartShowLaconicaStyles: backwards compatibility; deprecated
- $action: the current action

EndShowLaconicaStyles: backwards compatibility; deprecated
33 34
- $action: the current action

35
StartShowUAStyles: Showing custom User-Agent style links
36 37
- $action: the current action

38
EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
39 40
- $action: the current action

41 42 43 44 45 46 47 48 49 50 51 52 53
StartShowScripts: Showing JavaScript links
- $action: the current action

EndShowScripts: End showing JavaScript links; good place to add custom
		links like Google Analytics
- $action: the current action

StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
- $action: the current action

EndShowJQueryScripts: End showing JQuery script links
- $action: the current action

54
StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
55 56
- $action: the current action

57
EndShowStatusNetScripts: End showing StatusNet script links
58 59
- $action: the current action

60
StartShowLaconicaScripts: backwards compatibility; deprecated
61 62
- $action: the current action

63
EndShowLaconicaScripts: backwards compatibility; deprecated
64 65
- $action: the current action

66 67 68 69 70
StartShowSections: Start the list of sections in the sidebar
- $action: the current action

EndShowSections: End the list of sections in the sidebar
- $action: the current action
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

StartShowHeader: Showing before the header container
- $action: the current action

EndShowHeader: Showing after the header container
- $action: the current action

StartShowFooter: Showing before the footer container
- $action: the current action

EndShowFooter: Showing after the footer container
- $action: the current action

StartShowContentBlock: Showing before the content container
- $action: the current action

EndShowContentBlock: Showing after the content container
- $action: the current action

90 91 92 93 94 95
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)

96 97 98 99 100 101
StartShowLocalNavBlock: Showing the local nav menu
- $action: the current action

EndShowLocalNavBlock: At the end of the local nav menu
- $action: the current action

102
StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
103 104 105 106 107
- $action: the current action

EndShowHTML: Showing after the html element
- $action: the current action

108 109 110 111 112
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
113

114 115 116 117 118 119
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

120 121 122
RouterInitialized: After the router instance has been initialized
- $m: the Net_URL_Mapper that has just been set up

123 124 125 126 127 128
StartLogout: Before logging out
- $action: the logout action

EndLogout: After logging out
- $action: the logout action

129 130
ArgsInitialized: After the argument array has been initialized
- $args: associative array of arguments, can be modified
131 132 133 134 135 136

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 <address>
- $action: the current action
137 138 139 140 141 142

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
143 144 145 146 147 148

StartAccountSettingsNav: Before showing the account settings menu
- $action: the current action

EndAccountSettingsNav: After showing the account settings menu
- $action: the current action
149 150 151

Autoload: When trying to autoload a class
- $cls: the class being sought. A plugin might require_once the file for the class.
152 153 154 155 156

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

157 158 159
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
160 161 162 163 164 165 166 167 168 169 170 171 172

StartShowHead: called before showing the <head> element and children
- $action: action object being show

EndShowHead: called after showing the <head> element (and </head>)
- $action: action object being shown

StartShowBody: called before showing the <body> element and children
- $action: action object being shown

EndShowBody: called after showing the <body> element (and </body>)
- $action: action object being shown

173 174 175 176 177 178
StartHeadChildren: called before showing the children of <head> element (after <head> tag)
- $action: action object being shown

EndHeadChildren: called after showing the children of <head> element (before </head>)
- $action: action object being shown

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
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 </html> tag
- $action: action object being shown

EndEndHTML: just after the </html> 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 <div> with export data (feeds)
- $action: action object being shown

EndShowExportData: just after showing the <div> 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
238 239 240 241

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
242 243 244 245 246 247 248 249

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
250 251 252 253 254 255 256

StartApiRss: after the rss <channel> element is started
- $action: action object being shown

StartApiAtom: after the <feed> element is started
- $action: action object being shown