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 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 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 StartShowStylesheets: Showing stylesheet links - $action: the current action EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles - $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 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 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 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 StartShowAside: Showing before the Aside container - $action: the current action EndShowAside: Showing after the Aside container - $action: the current action StartShowNoticeFormData: Showing before the notice form data - $action: the current action EndShowNoticeFormData: Showing after the notice form data - $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 - $menu: the menu widget; use $menu->action for output EndPublicGroupNav: At the end of the public group nav menu - $menu: the menu widget; use $menu->action for output StartSubGroupNav: Showing the subscriptions group nav menu - $menu: the menu widget; use $menu->action for output EndSubGroupNav: At the end of the subscriptions group nav menu - $menu: the menu widget; use $menu->action for output StartInitializeRouter: Before the router instance has been initialized; good place to add routes - $m: the Net_URL_Mapper that has just been set up 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 ArgsInitialize: 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 StartShowSiteNotice: Before showing site notice - $action: the current action EndShowSiteNotice: After showing site notice - $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 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item - $widget: AccountSettingsNav instance being shown EndAccountSettingsProfileMenuItem: After showing the Profile menu item - $widget: AccountSettingsNav instance being shown StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item - $widget: AccountSettingsNav instance being shown EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item - $widget: AccountSettingsNav instance being shown StartAccountSettingsPasswordMenuItem: Before showing the Password menu item - $widget: AccountSettingsNav instance being shown EndAccountSettingsPasswordMenuItem: After showing the Password menu item - $widget: AccountSettingsNav instance being shown StartAccountSettingsEmailMenuItem: Before showing the Email menu item - $widget: AccountSettingsNav instance being shown EndAccountSettingsEmailMenuItem: After showing the Email menu item - $widget: AccountSettingsNav instance being shown StartAccountSettingsDesignMenuItem: Before showing the Design menu item - $widget: AccountSettingsNav instance being shown EndAccountSettingsDesignMenuItem: After showing the Design menu item - $widget: AccountSettingsNav instance being shown StartAccountSettingsOtherMenuItem: Before showing the Other menu item - $widget: AccountSettingsNav instance being shown EndAccountSettingsOtherMenuItem: After showing the Other menu item - $widget: AccountSettingsNav instance being shown 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 StartPersonalGroupNav: beginning of personal group nav menu - $menu: Menu list object being shown - $target: Profile for whom it is shown - $scoped: Profile of currently logged in user (or null) EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item) - $action: action object being shown StartGroupGroupNav: Showing the group nav menu - $action: the current action EndGroupGroupNav: At the end of the group nav menu - $action: the current action StartEndHTML: just before the tag - $action: action object being shown EndEndHTML: just after the tag - $action: action object being shown FinalAction: After prepare() (and possible handle) in Action class. - $status: result of "prepare" call on action - $action: Action that is currently running 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 StartShowNoticeItem: just before showing the notice item - $item: The NoticeListItem object being shown EndShowNoticeItem: just after showing the notice item - $item: the NoticeListItem object being shown StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML - $item: The NoticeListItem object being shown EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML - $item: The NoticeListItem object being shown StartShowNoticeContent: just before outputting the content part of a Notice - $stored: The Notice object - $out: HTMLOutputter for writing to - $scoped: optional Profile object for permission scoping EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually - $stored: The Notice object - $out: HTMLOutputter for writing to - $scoped: optional Profile object for permission scoping StartShowNoticeInfo: just before showing notice info - $item: The NoticeListItem object being shown EndShowNoticeInfo: just after showing notice info - $item: The NoticeListItem object being shown StartShowNoticeOptions: just before showing notice options like fave, repeat, etc. - $item: the NoticeListItem object being shown EndShowNoticeOptions: just after showing notice options like fave, repeat, etc. - $item: the NoticeListItem 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 StartEmailFormData: just before showing form input fields on email settings page - $action: Action object being shown - $scoped: Profile for whom settings are being configured EndEmailFormData: just after showing form input fields on email settings page - $action: action object being shown - $scoped: Profile for whom settings are being configured StartEmailSaveForm: before starting to save a email settings form - $action: action object being shown - $scoped: Profile user having their email settings saved EndEmailSaveForm: after saving a email settings form (after commit) - $action: action object being shown - $scoped: Profile user having their email settings saved 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 StartAvatarFormData: before displaying avatar form - $action: action object being shown EndAvatarFormData: after displaying avatar form - $action: action object being shown StartAvatarSaveForm: before saving the avatar - $action: action object being shown EndAvatarSaveForm: after saving the avatar - $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 StartApiRss: after the rss element is started - $action: action object being shown StartApiAtom: after the element is started - $action: action object being shown StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport) - $notice: the notice being added - &$transports: modifiable list of transports (as strings) to queue for EndEnqueueNotice: after adding a notice to the queues - $notice: the notice being added - $transports: modifiable list of transports to use UnqueueHandleNotice: Handle a notice when no queue manager is available - $notice: the notice to handle - $queue: the "queue" that is being executed GetValidDaemons: Just before determining which daemons to run - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/ HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue) - &$notice: notice to handle StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces - $action: the current action - &$attrs: attributes for the HTML element EndHtmlElement: Right after outputting the HTML element - $action: the current action - &$attrs: attributes for the HTML element StartShowHeadElements: Right after the tag - $action: the current action EndShowHeadElements: Right before the tag; put