Plugin hooks reference
The following hooks are available for plugins to use:
InitializePlugin
A chance to initialize a plugin in a complete environment
CleanupPlugin
A chance to cleanup a plugin at the end of a program
Showing the primary nav menu
- $action: the current action
At the end of the primary nav menu
- $action: the current action
Showing the secondary nav menu
- $action: the current action
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 UA Style links
- $action: the current action
EndShowUAStyles
End showing custom UA Style 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
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
StartShowStatusNetScripts
Showing StatusNet script links (use this to link to a CDN or something)
- $action: the current action
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
- $action: the current action
EndShowSections
End the list of sections in the sidebar
- $action: the current action
StartShowBody
Showing before the body container
- $action: the current action
EndShowBody
Showing after the body container
- $action: the current action
StartShowHeader
Showing before the header container
- $action: the current action
EndShowHeader
Showing after the header container
- $action: the current action
Showing before the footer container
- $action: the current action
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
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)
Showing the local nav menu
- $action: the current action
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
Showing the public group nav menu
- $action: the current action
At the end of the public group nav menu
- $action: the current action
Showing the subscriptions group nav menu
- $action: the current action
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 <address>
- $action: the current action
StartShowHeadElements
Right after the <head> tag
- $action: the current action
EndShowHeadElements
Right before the </head> tag; put <script>s here if you need them in <head>
- $action: the current action