2010-02-17 00:22:58 +00:00
InitializePlugin: a chance to initialize a plugin in a complete environment
2009-02-09 13:44:30 +00:00
CleanupPlugin: a chance to cleanup a plugin at the end of a program
2015-02-27 11:11:43 +00:00
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
2009-02-09 13:11:52 +00:00
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
2009-02-09 13:24:23 +00:00
2009-02-13 04:33:43 +00:00
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
2013-09-17 19:41:54 +01:00
StartShowStylesheets: Showing stylesheet links
2009-02-13 04:33:43 +00:00
- $action: the current action
2013-09-17 19:41:54 +01:00
EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles
2009-02-13 04:33:43 +00:00
- $action: the current action
2009-08-04 18:00:44 +01:00
StartShowUAStyles: Showing custom User-Agent style links
2009-02-13 04:33:43 +00:00
- $action: the current action
2009-08-04 18:00:44 +01:00
EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
2009-02-13 04:33:43 +00:00
- $action: the current action
2009-02-09 13:24:23 +00:00
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
2009-08-25 23:30:48 +01:00
StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
2009-02-09 13:24:23 +00:00
- $action: the current action
2009-08-25 23:30:48 +01:00
EndShowStatusNetScripts: End showing StatusNet script links
2009-02-09 13:24:23 +00:00
- $action: the current action
2009-02-09 21:56:38 +00:00
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
2009-02-12 22:16:48 +00:00
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
2009-10-01 13:27:02 +01:00
StartShowAside: Showing before the Aside container
- $action: the current action
EndShowAside: Showing after the Aside container
- $action: the current action
2009-10-05 15:17:55 +01:00
StartShowNoticeFormData: Showing before the notice form data
- $action: the current action
EndShowNoticeFormData: Showing after the notice form data
- $action: the current action
2009-02-13 15:52:26 +00:00
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)
2009-02-20 23:47:24 +00:00
StartShowLocalNavBlock: Showing the local nav menu
- $action: the current action
EndShowLocalNavBlock: At the end of the local nav menu
- $action: the current action
2009-03-04 05:23:41 +00:00
StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
2009-02-26 19:56:31 +00:00
- $action: the current action
EndShowHTML: Showing after the html element
- $action: the current action
2009-03-04 05:23:41 +00:00
StartPublicGroupNav: Showing the public group nav menu
2010-11-08 15:26:33 +00:00
- $menu: the menu widget; use $menu->action for output
2009-03-04 05:23:41 +00:00
EndPublicGroupNav: At the end of the public group nav menu
2010-11-08 15:26:33 +00:00
- $menu: the menu widget; use $menu->action for output
2009-03-04 15:34:04 +00:00
2009-05-15 19:22:49 +01:00
StartSubGroupNav: Showing the subscriptions group nav menu
2010-11-08 15:26:33 +00:00
- $menu: the menu widget; use $menu->action for output
2009-05-15 19:22:49 +01:00
EndSubGroupNav: At the end of the subscriptions group nav menu
2010-11-08 15:26:33 +00:00
- $menu: the menu widget; use $menu->action for output
2009-05-15 19:22:49 +01:00
2009-10-28 20:07:57 +00:00
StartInitializeRouter: Before the router instance has been initialized; good place to add routes
- $m: the Net_URL_Mapper that has just been set up
2009-03-04 15:34:04 +00:00
RouterInitialized: After the router instance has been initialized
- $m: the Net_URL_Mapper that has just been set up
2009-05-15 22:41:41 +01:00
StartLogout: Before logging out
- $action: the logout action
EndLogout: After logging out
- $action: the logout action
2010-02-07 17:29:42 +00:00
ArgsInitialize: After the argument array has been initialized
2009-05-15 20:07:23 +01:00
- $args: associative array of arguments, can be modified
2009-07-02 17:06:06 +01:00
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
2009-08-04 11:52:57 +01:00
2010-01-21 15:49:49 +00:00
StartShowSiteNotice: Before showing site notice
- $action: the current action
EndShowSiteNotice: After showing site notice
- $action: the current action
2009-08-04 11:52:57 +01:00
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
2009-08-04 12:08:10 +01:00
StartAccountSettingsNav: Before showing the account settings menu
- $action: the current action
EndAccountSettingsNav: After showing the account settings menu
- $action: the current action
2009-08-04 12:34:58 +01:00
2009-11-10 22:54:24 +00:00
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
2009-08-04 12:34:58 +01:00
Autoload: When trying to autoload a class
- $cls: the class being sought. A plugin might require_once the file for the class.
2009-08-04 13:58:24 +01:00
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
2009-08-04 16:13:47 +01:00
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
2009-08-04 18:00:44 +01:00
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
StartPersonalGroupNav: beginning of personal group nav menu
2014-06-28 12:11:03 +01:00
- $menu: Menu list object being shown
- $target: Profile for whom it is shown
- $scoped: Profile of currently logged in user (or null)
2009-08-04 18:00:44 +01:00
EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
- $action: action object being shown
2009-11-10 13:52:47 +00:00
StartGroupGroupNav: Showing the group nav menu
- $action: the current action
EndGroupGroupNav: At the end of the group nav menu
- $action: the current action
2009-08-04 18:00:44 +01:00
StartEndHTML: just before the </html> tag
- $action: action object being shown
EndEndHTML: just after the </html> tag
- $action: action object being shown
Cron plugin added and now default queue handler
Generally the Cron plugin will run if there's still execution time for
1 second since starting the Action processing. If you want to change
this (such as disabling, 0 seconds, or maybe running bigger chunks,
for like 4 seconds) you can do this, where 'n' is time in seconds.
addPlugin('Cron', array('secs_per_action', n));
Add 'rel_to_pageload'=>false to the array if you want to run the queue
for a certain amount of seconds _despite_ maybe already having run that
long in the previous parts of Action processing.
Perhaps you want to run the cron script remotely, using a machine capable
of background processing (or locally, to avoid running daemon processes),
simply do an HTTP GET request to the route /main/cron of your GNU social.
Setting secs_per_action to 0 in the plugin config will imply that you run
all your queue handling by calling /main/cron (which runs as long as it can).
/main/cron will output "0" if it has finished processing, "1" if it should
be called again to complete processing (because it ran out of time due to
PHP's max_execution_time INI setting).
The Cron plugin also runs events as close to hourly, daily and weekly
as you get, based on the opportunistic method of running whenever a user
visits the site. This means of course that the cron events should be as
fast as possible, not only to avoid delaying page load for users but
also to minimize the risk of running into PHP's max_execution_time. One
suggestion is to only use the events to add new queue items for later processing.
These events are called CronHourly, CronDaily, CronWeekly - however there
is no guarantee that all events will execute, so some kind of failsafe,
transaction-ish method must be implemented in the future.
2013-11-19 13:13:33 +00:00
FinalAction: After prepare() (and possible handle) in Action class.
- $status: result of "prepare" call on action
- $action: Action that is currently running
2009-08-04 18:00:44 +01:00
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
2009-09-25 13:47:14 +01:00
StartShowNoticeItem: just before showing the notice item
2010-09-29 01:09:34 +01:00
- $item: The NoticeListItem object being shown
2009-09-25 13:47:14 +01:00
EndShowNoticeItem: just after showing the notice item
2010-09-29 01:09:34 +01:00
- $item: the NoticeListItem object being shown
2010-09-29 20:49:26 +01:00
2014-10-26 20:41:04 +00:00
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
2010-09-29 20:49:26 +01:00
StartShowNoticeInfo: just before showing notice info
- $item: The NoticeListItem object being shown
EndShowNoticeInfo: just after showing notice info
- $item: The NoticeListItem object being shown
2010-09-29 01:09:34 +01:00
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
2009-08-04 18:00:44 +01:00
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
2014-07-13 14:29:58 +01:00
StartEmailFormData: just before showing form input fields on email settings page
- $action: Action object being shown
- $scoped: Profile for whom settings are being configured
2010-11-09 20:00:30 +00:00
2014-07-13 14:29:58 +01:00
EndEmailFormData: just after showing form input fields on email settings page
2010-11-09 20:00:30 +00:00
- $action: action object being shown
2014-07-13 14:29:58 +01:00
- $scoped: Profile for whom settings are being configured
2010-11-09 20:00:30 +00:00
StartEmailSaveForm: before starting to save a email settings form
- $action: action object being shown
2014-07-13 14:42:15 +01:00
- $scoped: Profile user having their email settings saved
2010-11-09 20:00:30 +00:00
EndEmailSaveForm: after saving a email settings form (after commit)
- $action: action object being shown
2014-07-13 14:42:15 +01:00
- $scoped: Profile user having their email settings saved
2010-11-09 20:00:30 +00:00
2009-08-04 18:00:44 +01:00
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
2009-12-10 03:31:07 +00:00
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
2009-08-04 18:00:44 +01:00
StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
- $qm: empty queue manager to set
2009-08-04 18:10:37 +01:00
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
2009-08-21 21:54:35 +01:00
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
2009-08-28 19:42:51 +01:00
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
2009-09-21 19:14:55 +01:00
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
2009-09-21 19:23:35 +01:00
UnqueueHandleNotice: Handle a notice when no queue manager is available
- $notice: the notice to handle
2009-09-21 19:29:43 +01:00
- $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/
2009-09-21 19:39:22 +01:00
HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
- &$notice: notice to handle
2009-09-24 22:15:54 +01:00
2010-10-30 00:38:00 +01:00
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
2009-09-24 04:23:13 +01:00
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
2009-10-01 20:11:12 +01:00
CheckSchema: chance to check the schema
2009-10-09 20:28:12 +01:00
2010-02-13 17:40:36 +00:00
StartProfileRemoteSubscribe: Before showing the link to remote subscription
- $userprofile: UserProfile widget
- &$profile: the profile being shown
EndProfileRemoteSubscribe: After showing the link to remote subscription
- $userprofile: UserProfile widget
- &$profile: the profile being shown
2010-03-03 17:01:38 +00:00
StartGroupSubscribe: Before showing the link to remote subscription
- $action: the current action
- $group: the group being shown
EndGroupSubscribe: After showing the link to remote subscription
- $action: the current action
- $group: the group being shown
2009-10-09 21:14:20 +01:00
StartProfilePageProfileSection: Starting to show the section of the
2009-10-09 20:28:12 +01:00
profile page with the actual profile data;
hook to prevent showing the profile (e.g.)
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
StartProfilePageProfileElements: inside the section, before the first
2009-10-09 20:28:12 +01:00
element; prepend elements here
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
EndProfilePageProfileElements: inside the section, after the last element;
2009-10-09 20:28:12 +01:00
append elements here
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
EndProfilePageProfileSection: After showing the section of the profile
2009-10-09 20:28:12 +01:00
page with the profile elements
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
StartProfilePageActionsSection: Starting to show the section of the
2009-10-09 20:28:12 +01:00
profile page with action links; hook
to hide them (for example)
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
StartProfilePageActionsElements: inside the list, before the first
2009-10-09 20:28:12 +01:00
element; prepend elements here
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
EndProfilePageActionsElements: inside the list, after the last element;
2009-10-09 20:28:12 +01:00
append elements here
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
EndProfilePageActionsSection: After showing the section of the profile
2009-10-09 20:28:12 +01:00
page with the entity actions
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 20:28:12 +01:00
- &$profile: the profile being shown
2009-10-09 21:14:20 +01:00
StartProfilePageAvatar: before showing the avatar on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageAvatar: after showing the avatar on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
StartProfilePageNickname: before showing the nickname on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageNickname: after showing the nickname on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
StartProfilePageFullName: before showing the fullname on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageFullName: after showing the fullname on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
StartProfilePageLocation: before showing the location on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageLocation: after showing the location on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
StartProfilePageHomepage: before showing the homepage link on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageHomepage: after showing the homepage on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
StartProfilePageBio: before showing the bio on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageBio: after showing the bio on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
StartProfilePageProfileTags: before showing the tags on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
EndProfilePageProfileTags: after showing the tags on the profile page
2009-11-08 02:52:21 +00:00
- $userprofile: UserProfile widget
2009-10-09 21:14:20 +01:00
- &$profile: the profile being shown
2009-10-15 11:01:26 +01:00
StartProfileList: when starting a list of profiles (before <ul>)
- $profilelist: ProfileList widget, with $profile, $action, and $out
EndProfileList: when ending a list of profiles (after </ul>)
- $profilelist: ProfileList widget
StartProfileListItem: when starting to show a profile list item
- $item: ProfileListItem widget
EndProfileListItem: after showing a profile list item
- $item: ProfileListItem widget
StartProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget
EndProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget
StartProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget
EndProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget
StartProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget
EndProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget
StartProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget
EndProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget
StartProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget
EndProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget
StartProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget
EndProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget
StartProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget
EndProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget
StartProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget
EndProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget
StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
- $item: ProfileListItem widget
EndProfileListItemActionElements: Showing profile list actions (append a button here)
- $item: ProfileListItem widget
2009-10-29 20:01:25 +00:00
StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
EndUserXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
2009-11-04 18:06:55 +00:00
2009-11-10 19:45:19 +00:00
StartCheckPassword: Check a username/password
2009-11-04 18:06:55 +00:00
- $nickname: The nickname to check
- $password: The password to check
2009-11-10 19:45:19 +00:00
- &$authenticatedUser: set to User object if credentials match a user.
2009-11-05 21:39:57 +00:00
2009-11-10 19:45:19 +00:00
EndCheckPassword: After checking a username/password pair
- $nickname: The nickname that was checked
- $password: The password that was checked
- $authenticatedUser: User object if credentials match a user, else null.
2009-11-05 21:39:57 +00:00
2009-11-10 21:27:20 +00:00
StartChangePassword: Before changing a password
2009-11-13 01:12:00 +00:00
- $user: user
2009-11-06 04:27:18 +00:00
- $oldpassword: the user's old password
- $newpassword: the desired new password
2009-11-10 21:27:20 +00:00
EndChangePassword: After changing a password
2009-11-13 01:12:00 +00:00
- $user: user
2009-11-06 04:27:18 +00:00
2013-10-17 15:32:53 +01:00
StartHashPassword: Generate a hashed version of the password (like a salted crypt)
- &$hashed: Hashed version of the password, later put in the database
- $password: The password that should be hashed
- $profile: Profile that this password and hash belongs to. Can be null.
2009-11-18 19:19:43 +00:00
StartSetUser: Before setting the currently logged in user
- $user: user
EndSetUser: After setting the currently logged in user
- $user: user
StartSetApiUser: Before setting the current API user
2015-02-13 00:19:59 +00:00
- &$user: user, can be set during event handling (return false to stop processing)
2009-11-18 19:19:43 +00:00
EndSetApiUser: After setting the current API user
2015-02-13 00:19:59 +00:00
- $user: user, only called if this is an actual user
2009-11-18 19:19:43 +00:00
StartHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $name: name of the role in question
- &$has_role: does this profile have the named role?
EndHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $name: name of the role in question
- $has_role: does this profile have the named role?
2009-11-08 13:33:22 +00:00
UserDeleteRelated: Specify additional tables to delete entries from when deleting users
- $user: User object
- &$related: array of DB_DataObject class names to delete entries on matching user_id.
2009-11-11 19:02:57 +00:00
GetUrlShorteners: Specify URL shorteners that are available for use
- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
StartShortenUrl: About to shorten a URL
- $url: url to be shortened
- $shortenerName: name of the requested shortener
- &$shortenedUrl: short version of the url
EndShortenUrl: After a URL has been shortened
- $url: url to be shortened
- $shortenerName: name of the requested shortener
- $shortenedUrl: short version of the url
2009-12-04 06:57:14 +00:00
StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
- $action
- &$src
- &$theme
- &$media
EndCssLinkElement: After a <link rel="stylesheet"..> element is written
- $action
- $src
- $theme
- $media
2009-12-05 01:19:55 +00:00
StartStyleElement: Before a <style...> element is written
- $action
- &$code
- &$type
- &$media
EndStyleElement: After a <style...> element is written
- $action
- $code
- $type
- $media
2009-12-04 06:57:14 +00:00
StartScriptElement: Before a <script...> element is written
- $action
- &$src
- &$type
EndScriptElement: After a <script...> element is written
- $action
- $src
- $type
2009-12-05 00:51:44 +00:00
StartInlineScriptElement: Before a <script...> element is written
- $action
- &$code
- &$type
EndInlineScriptElement: After a <script...> element is written
- $action
- $code
- $type
2009-12-05 07:11:27 +00:00
StartLog: Before writing to the logs
- &$priority
- &$msg
- &$filename
EndLog: After writing to the logs
- $priority
- $msg
- $filename
2009-12-28 18:42:55 +00:00
StartBlockProfile: when we're about to block
- $user: the person doing the block
- $profile: the person getting blocked, can be remote
EndBlockProfile: when a block has succeeded
- $user: the person doing the block
- $profile: the person blocked, can be remote
2009-12-28 18:50:12 +00:00
StartUnblockProfile: when we're about to unblock
- $user: the person doing the unblock
- $profile: the person getting unblocked, can be remote
EndUnblockProfile: when an unblock has succeeded
- $user: the person doing the unblock
- $profile: the person unblocked, can be remote
2010-01-13 10:16:13 +00:00
StartSubscribe: when a subscription is starting
2013-09-09 20:35:16 +01:00
- $profile: Profile that is subscribing
- $other: Profile that is being subscribed to
2010-01-13 10:16:13 +00:00
EndSubscribe: when a subscription is finished
2013-09-09 20:35:16 +01:00
- $profile: Profile that is subscribing
- $other: Profile that is being subscribed to
2010-01-13 10:16:13 +00:00
StartUnsubscribe: when an unsubscribe is starting
2013-09-09 20:35:16 +01:00
- $profile: Profile that is unsubscribing
- $other: Profile that is being unsubscribed from
2010-01-13 10:16:13 +00:00
EndUnsubscribe: when an unsubscribe is done
2013-09-09 20:35:16 +01:00
- $profile: Profile that is unsubscribing
- $other: Profile that is being unsubscribed from
2010-01-13 10:16:13 +00:00
StartJoinGroup: when a user is joining a group
- $group: the group being joined
2011-03-21 21:35:29 +00:00
- $profile: the local or remote user joining
2010-01-13 10:16:13 +00:00
EndJoinGroup: when a user finishes joining a group
- $group: the group being joined
2011-03-21 21:35:29 +00:00
- $profile: the local or remote user joining
2010-01-13 10:16:13 +00:00
StartLeaveGroup: when a user is leaving a group
- $group: the group being left
2011-03-21 21:35:29 +00:00
- $profile: the local or remote user leaving
2010-01-13 10:16:13 +00:00
EndLeaveGroup: when a user has left a group
- $group: the group being left
2011-03-21 21:35:29 +00:00
- $profile: the local or remote user leaving
2010-01-19 04:25:45 +00:00
StartShowContentLicense: Showing the default license for content
- $action: the current action
EndShowContentLicense: Showing the default license for content
- $action: the current action
2010-01-23 06:25:27 +00:00
GetImTransports: Get IM transports that are available
- &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
NormalizeImScreenname: Normalize an IM screenname
- $transport: transport the screenname is on
- &$screenname: screenname to be normalized
ValidateImScreenname: Validate an IM screenname
- $transport: transport the screenname is on
- $screenname: screenname to be validated
- $valid: is the screenname valid?
SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
- $transport: transport the screenname exists on
- $screenname: screenname being confirmed
- $code: confirmation code for confirmation URL
- $user: user requesting the confirmation
2010-02-02 22:00:10 +00:00
2010-01-29 22:54:54 +00:00
StartUserRegister: When a new user is being registered
2013-09-14 17:36:35 +01:00
- $profile: Profile object with new profile data (no ID yet)
2010-01-29 22:54:54 +00:00
EndUserRegister: When a new user has been registered
2013-09-14 17:36:35 +01:00
- $profile: Profile object with new profile data
2010-01-29 22:54:54 +00:00
2010-01-31 15:12:26 +00:00
StartRobotsTxt: Before outputting the robots.txt page
- &$action: RobotstxtAction being shown
EndRobotsTxt: After the default robots.txt page (good place for customization)
- &$action: RobotstxtAction being shown
2010-02-17 04:13:39 +00:00
StartGetProfileUri: When determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
2010-02-17 00:22:58 +00:00
2010-02-17 04:13:39 +00:00
EndGetProfileUri: After determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
2010-02-20 17:03:32 +00:00
2013-10-28 17:01:39 +00:00
StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
- $profile: Profile of user we want to get acct: URI for
- &$acct: string with the resulting acct: uri
EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
- $profile: Profile of user we want to get acct: URI for
- &$acct: string with the resulting acct: uri
2010-02-21 21:20:30 +00:00
StartFindMentions: start finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
- &$mentions: mentions found so far. Array of arrays; each array
has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
'title' (title of the link), 'position' (position of the text to
replace), 'text' (text to replace)
EndFindMentions: end finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
- &$mentions: mentions found so far. Array of arrays; each array
has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
'title' (title of the link), 'position' (position of the text to
replace), 'text' (text to replace)
2010-02-22 16:03:28 +00:00
StartShowSubscriptionsContent: before showing the subscriptions content
- $action: the current action
EndShowSubscriptionsContent: after showing the subscriptions content
- $action: the current action
2010-02-26 17:40:30 +00:00
2010-03-03 20:29:51 +00:00
StartShowUserGroupsContent: before showing the user groups content
- $action: the current action
EndShowUserGroupsContent: after showing the user groups content
- $action: the current action
2010-03-02 17:33:25 +00:00
StartShowAllContent: before showing the all (you and friends) content
- $action: the current action
EndShowAllContent: after showing the all (you and friends) content
- $action: the current action
2010-03-03 16:14:39 +00:00
StartShowSubscriptionsMiniList: at the start of subscriptions mini list
- $action: the current action
EndShowSubscriptionsMiniList: at the end of subscriptions mini list
- $action: the current action
2010-03-03 17:55:01 +00:00
StartShowGroupsMiniList: at the start of groups mini list
- $action: the current action
EndShowGroupsMiniList: at the end of groups mini list
- $action: the current action
2010-02-06 11:59:41 +00:00
StartDeleteUserForm: starting the data in the form for deleting a user
- $action: action being shown
- $user: user being deleted
EndDeleteUserForm: Ending the data in the form for deleting a user
- $action: action being shown
- $user: user being deleted
StartDeleteUser: handling the post for deleting a user
- $action: action being shown
- $user: user being deleted
EndDeleteUser: handling the post for deleting a user
- $action: action being shown
- $user: user being deleted
2010-12-05 21:20:00 +00:00
StartNoticeAsActivity: before converting a notice to an activity
- $notice: notice being converted
- &$activity: initially empty activity
EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
- $notice: notice being converted
- &$activity: activity, now more-or-less full
2010-08-13 19:21:07 +01:00
StartNoticeSaveWeb: before saving a notice through the Web interface
- $action: action being executed (instance of NewNoticeAction)
- &$authorId: integer ID of the author
- &$text: text of the notice
- &$options: additional options (location, replies, etc.)
EndNoticeSaveWeb: after saving a notice through the Web interface
- $action: action being executed (instance of NewNoticeAction)
- $notice: notice that was saved
2010-08-13 19:44:26 +01:00
StartRssEntryArray: at the start of copying a notice to an array
- $notice: the notice being copied
- &$entry: the entry (empty at beginning)
EndRssEntryArray: at the end of copying a notice to an array
- $notice: the notice being copied
- &$entry: the entry, with all the fields filled up
2010-08-14 19:54:20 +01:00
NoticeDeleteRelated: at the beginning of deleting related fields to a notice
- $notice: notice being deleted
2010-09-02 22:10:25 +01:00
2014-05-12 14:16:41 +01:00
FileDeleteRelated: at the beginning of deleting related fields to a File
- $notice: File being deleted
2010-09-02 22:10:25 +01:00
StartShowHeadTitle: when beginning to show the <title> element
- $action: action being shown
EndShowHeadTitle: when done showing the <title>
- $action: action being shown
StartShowPageTitle: when beginning to show the page title <h1>
- $action: action being shown
EndShowPageTitle: when done showing the page title <h1>
2010-09-05 22:43:29 +01:00
- $action: action being shown
2010-09-08 21:37:12 +01:00
StartDeleteOwnNotice: when a user starts to delete their own notice
- $user: the user doing the delete
- $notice: the notice being deleted
EndDeleteOwnNotice: when a user has deleted their own notice
- $user: the user doing the delete
- $notice: the notice being deleted
2010-09-29 18:23:46 +01:00
StartShowFeedLinkList: before showing the feed list in the sidebar
- $action: action being executed
- $feeds: list of feeds to show
EndShowFeedLinkList: after showing the feed list in the sidebar
- $action: action being executed
- $feeds: list of feeds shown
StartShowFeedLink: before showing an individual feed item
- $action: action being executed
- $feed: feed to show
EndShowFeedLink: after showing an individual feed
- $action: action being executed
- $feed: feed to show
2010-10-07 15:22:57 +01:00
StartShowNoticeForm: before showing the notice form (before <form>)
- $action: action being executed
EndShowNoticeForm: after showing the notice form (after <form>)
- $action: action being executed
2010-10-22 15:31:50 +01:00
2014-02-24 01:05:31 +00:00
StartShowEntryForms: microapp entry form tab data
- &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
2010-10-22 15:31:50 +01:00
StartGrantRole: when a role is being assigned
- $profile: profile that will have the role
- $role: string name of the role
EndGrantRole: when a role has been successfully assigned
- $profile: profile that will have the role
- $role: string name of the role
StartRevokeRole: when a role is being revoked
- $profile: profile that will lose the role
- $role: string name of the role
EndRevokeRole: when a role has been revoked
- $profile: profile that lost the role
- $role: string name of the role
2010-11-15 16:54:42 +00:00
StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
- &$activity: received activity
2015-01-12 01:28:03 +00:00
- $profile: profile of the user publishing the entry
2010-12-28 06:13:17 +00:00
- &$notice: notice created; initially null, can be set
2010-11-15 16:54:42 +00:00
EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
- $activity: received activity
2015-01-12 01:28:03 +00:00
- $profile: profile of the user publishing the entry
2010-11-15 16:54:42 +00:00
- $notice: notice that was created
2010-12-17 04:13:17 +00:00
AdminPanelCheck: When checking whether the current user can access a given admin panel
- $name: Name of the admin panel
- &$isOK: Boolean whether the user is allowed to use the panel
StartAdminPanelNav: Before displaying the first item in the list of admin panels
- $nav The AdminPanelNav widget
EndAdminPanelNav: After displaying the last item in the list of admin panels
- $nav The AdminPanelNav widget
2010-12-18 22:24:41 +00:00
StartActivityObjectFromNotice: When converting a notice to an activity:object
- $notice: The notice being converted
- &$object: The resulting object. Fill this and return false to override defaults.
EndActivityObjectFromNotice: After converting a notice to an activity:object
- $notice: The notice being converted
- &$object: The resulting object. Can be edited
StartActivityObjectFromProfile: When converting a profile to an activity:object
- $profile: The profile being converted
- &$object: The (empty) object. Fill it up and return false to override defaults.
EndActivityObjectFromProfile: After converting a profile to an activity:object
- $profile: The profile being converted
- &$object: The finished object. Can be tweaked
StartActivityObjectFromGroup: When converting a group to an activity:object
- $group: The group being converted
- &$object: The (empty) object. Fill and return false to override.
EndActivityObjectFromGroup: After converting a group to an activity:object
- $group: The group being converted
- &$object: The finished object. Tweak as needed.
2010-12-28 06:37:34 +00:00
StartImportActivity: when we start to import an activity
- $user: User to make the author import
- $author: Author of the feed; good for comparisons
- $activity: The current activity
- $trusted: How "trusted" the process is
- &$done: Return value; whether to continue
EndImportActivity: when we finish importing an activity
- $user: User to make the author import
- $author: Author of the feed; good for comparisons
- $activity: The current activity
- $trusted: How "trusted" the process is
2010-12-29 22:02:04 +00:00
StartProfileSettingsActions: when we're showing account-management action list
- $action: Action being shown (use for output)
EndProfileSettingsActions: when we're showing account-management action list
- $action: Action being shown (use for output)
2010-12-31 00:57:05 +00:00
StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
- $nli: The notice list item being shown
EndOpenNoticeListItemElement: After the opening <li> of a notice list element
- $nli: The notice list item being shown
StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
- $nli: The notice list item being shown
EndCloseNoticeListItemElement: After the closing </li> of a notice list element
- $nli: The notice list item being shown
2011-01-27 01:21:43 +00:00
StartGroupEditFormData: Beginning the group edit form entries
- $form: The form widget being shown
EndGroupEditFormData: Ending the group edit form entries
- $form: The form widget being shown
2011-01-27 01:35:01 +00:00
StartGroupSave: After initializing but before saving a group
- &$group: group about to be saved
EndGroupSave: After saving a group, aliases, and first member
- $group: group that was saved
2011-02-03 22:04:16 +00:00
StartInterpretCommand: Before running a command
2011-04-13 05:08:02 +01:00
- $cmd: First word in the string, 'foo' in 'foo argument'
2011-02-03 22:04:16 +00:00
- $arg: Argument, if any, like 'argument' in 'foo argument'
- $user: User who issued the command
- &$result: Resulting command; you can set this!
EndInterpretCommand: Before running a command
2011-04-13 05:08:02 +01:00
- $cmd: First word in the string, 'foo' in 'foo argument'
2011-02-03 22:04:16 +00:00
- $arg: Argument, if any, like 'argument' in 'foo argument'
- $user: User who issued the command
- $result: Resulting command
2011-02-07 15:23:56 +00:00
StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
- $action: action being executed (for output and params)
- $group: group for the page
EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
- $action: action being executed (for output and params)
- $group: group for the page
2011-02-07 19:04:58 +00:00
StartGroupProfileElements: Start showing stuff about the group on its profile page
- $action: action being executed (for output and params)
- $group: group for the page
2011-04-13 05:08:02 +01:00
2011-02-07 19:04:58 +00:00
EndGroupProfileElements: Start showing stuff about the group on its profile page
- $action: action being executed (for output and params)
- $group: group for the page
2011-03-11 19:54:23 +00:00
2011-03-06 19:18:02 +00:00
StartShowProfileTagContent: When showing a people tag page
- $action: action being executed (for output and params)
EndShowProfileTagContent: After showing the contents of a people tag page
- $action: action being executed (for output and params)
StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
- $action: action being executed (for output and params)
EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
- $action: action being executed (for output and params)
StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
- $action: action being executed (for output and params)
EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
- $action: action being executed (for output and params)
StartTagProfileAction: When starting to show profile tagging page
- $action: action being executed (for output and params)
- $profile: profile being tagged
EndTagProfileAction: After showing profile tagging page
- $action: action being executed (for output and params)
- $profile: profile being tagged
StartProfileCompletionSearch: When starting a profile search for autocompletion
- $action: action being executed (for output and params)
- &$profile: result Profile objects
- $search_engine: the search engine
EndProfileCompletionSearch: After search results for profile autocompletion have been found
- $action: profilec completion action
- &$profile: current result Profile objects
- $search_engine: The search engine object
StartShowTagProfileForm: When showing people tagging form
- $action: action being executed (for output and params)
- $profile: profile being tagged
EndShowTagProfileForm: After showing people tagging form
- $action: action being executed (for output and params)
- $profile: profile being tagged
StartSavePeopletags: When starting to save people tags
- $action: action being executed (for output and params)
- $tagstring: string input, a list of tags
EndSavePeopletags: After saving people tags
- $action: action being executed (for output and params)
- $tagstring: string input, a list of tags
StartProfiletagGetUri: when generating the Uri for a people tag
- $profile_list: the people tag, a Profile_list object
- &$uri: the URI
EndProfiletagGetUri: after generating the uri for a people tag
- $profile_list: the people tag, a Profile_list object
- &$uri: the URI
StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL
EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL
StartProfiletagPermalink: when generating the permalink url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL
EndProfiletagPermalink: after generating the permalink url for a people tag
- $profile_list: the people tag, a Profile_list object
- &$url: the URL
StartTagProfile: when tagging a profile
- $tagger: profile tagging
- $tagged: profile being tagged
- $tag: the tag
EndTagProfile: after tagging a profile
- $newtag: the newly created Profile_tag object
StartUntagProfile: when deleting a people tag
- $ptag: the Profile_tag object being deleted
EndUntagProfile: after deleting a people tag
- $orig: a copy of the deleted Profile_tag object
StartSubscribePeopletag: when subscribing to a people tag
- $peopletag: Profile_list object being subscribed to
- $profile: subscriber's profile
EndSubscribePeopletag: after subscribing to a people tag
- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
- $profile: subscriber's profile
StartUnsubscribePeopletag: when unsubscribing to a people tag
- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
- $profile: subscriber's profile
EndUnsubscribePeopletag: after unsubscribing to a people tag
- $peopletag: Profile_list object being subscribed to
- $profile: subscriber's profile
StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
- $profile_list: the people tag, a Profile_list object
- &$object: activity object
EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
- $profile_list: the people tag, a Profile_list object
- &$object: activity object
StartPeopletagGroupNav: Showing the people tag nav menu
- $menu: the menu widget; use $menu->action for output
EndPeopletagGroupNav: after showing the people tag nav menu
- $menu: the menu widget; use $menu->action for output
StartShowPeopletagItem: when showing a people tag
- $widget: PeopletagListItem widget
EndShowPeopletagItem: after showing a people tag
- $widget: PeopletagListItem widget
StartSubscribePeopletagForm: when showing people tag subscription form
- $action: action being executed (for output and params)
- $peopletag: people tag being subscribed to
EndSubscribePeopletagForm: after showing the people tag subscription form
- $action: action being executed (for output and params)
- $peopletag: people tag being subscribed to
StartShowPeopletags: when showing a textual list of people tags
- $widget: PeopletagsWidget; use $widget->out for output
- $tagger: profile of the tagger
- $tagged: profile tagged
EndShowPeopletags: after showing a textual list of people tags
- $widget: PeopletagsWidget; use $widget->out for output
- $tagger: profile of the tagger
- $tagged: profile tagged
StartProfileListItemTags: when showing people tags in a profile list item widget
- $widget: ProfileListItem widget
EndProfileListItemTags: after showing people tags in a profile list item widget
- $widget: ProfileListItem widget
2011-03-22 02:26:25 +00:00
2011-03-11 19:54:23 +00:00
StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
- $obj: ActivityObject
- $out: XMLOutputter to append custom output
EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
- $obj: ActivityObject
- $out: XMLOutputter to append custom output
StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
- $obj ActivityObject
- &$out: array to be serialized; you're free to modify it
EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
- $obj ActivityObject
- &$out: array to be serialized; you're free to modify it
2011-03-15 19:49:17 +00:00
StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.
- $notice Notice
- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent.
- $notice Notice
- &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
2011-04-05 23:07:10 +01:00
StartDefaultLocalNav: When showing the default local nav
- $menu: the menu
- $user: current user
EndDefaultLocalNav: When showing the default local nav
- $menu: the menu
- $user: current user
2011-04-08 23:45:49 +01:00
StartShowAccountProfileBlock: When showing the profile block for an account
- $out: XMLOutputter to append custom output
- $profile: the profile being shown
EndShowAccountProfileBlock: After showing the profile block for an account
- $out: XMLOutputter to append custom output
- $profile: the profile being shown
StartShowGroupProfileBlock: When showing the profile block for a group
- $out: XMLOutputter to append custom output
- $profile: the profile being shown
2011-04-10 09:10:01 +01:00
EndShowGroupProfileBlock: After showing the profile block for a group
2011-04-08 23:45:49 +01:00
- $out: XMLOutputter to append custom output
2011-04-09 21:58:38 +01:00
- $group: the group being shown
2014-05-12 09:27:52 +01:00
StartShowConversation: start the listing of a conversation
- $action: Action object (used mainly as HTMLOutputter)
- $conv: Conversation object, has functions to retrieve relevant notices
- $scoped: Profile for scoping (null if not logged in)
EndShowConversation: after the listing of a conversation
- $action: Action object (used mainly as HTMLOutputter)
- $conv: Conversation object, has functions to retrieve relevant notices
- $scoped: Profile for scoping (null if not logged in)
2011-04-09 21:58:38 +01:00
StartShowThreadedNoticeTail: when showing the replies etc. to a notice
- $nli: parent noticelistitem
- $notice: parent notice
- &$children: list of children
EndShowThreadedNoticeTail: when showing the replies etc. to a notice
- $nli: parent noticelistitem
- $notice: parent notice
- $children: list of children
StartShowThreadedNoticeSub: when showing a reply to a notice
- $nli: parent noticelistitem
- $parent: parent notice
- $child: child notice
EndShowThreadedNoticeSub: when showing a reply to a notice
- $nli: parent noticelistitem
- $parent: parent notice
- $child: child notice
2011-04-10 09:10:01 +01:00
2011-04-11 21:38:57 +01:00
StartAddEmailAddress: when adding an email address through the Web UI
- $user: user getting the new address
- $email: email being added
EndAddEmailAddress: done adding an email address through the Web UI
- $user: user getting the new address
- $email: email being added
2011-04-11 21:49:28 +01:00
StartValidateEmailInvite: when validating an email address for invitations
- $user: user doing the invite
- $email: email address
- &$valid: flag for if it's valid; can be modified
EndValidateEmailInvite: after validating an email address for invitations
- $user: user doing the invite
- $email: email address
- &$valid: flag for if it's valid; can be modified
2011-04-13 05:08:02 +01:00
StartLocalURL: before resolving a local url for an action
- &$action: action to find a path for
- &$paramsi: parameters to pass to the action
- &$fragment: any url fragement
- &$addSession: whether to add session variable
- &$url: resulting URL to local resource
EndLocalURL: before resolving a local url for an action
- &$action: action to find a path for
- &$paramsi: parameters to pass to the action
- &$fragment: any url fragement
- &$addSession: whether to add session variable
- &$url: resulting URL to local resource
2011-04-14 16:33:10 +01:00
StartProfileGetAvatar: When getting an avatar for a profile
- $profile: profile
- $size: size of the avatar
- &$avatar: avatar
EndProfileGetAvatar: After getting an avatar for a profile
- $profile: profile
- $size: size of the avatar
- &$avatar: avatar
2011-04-14 23:45:05 +01:00
StartRegisterSuccess: Before showing the registration success message
- $action: the registration action
StartRegisterSuccess: After showing the registration success message
- $action: the registration action
2011-05-04 19:30:56 +01:00
StartDocFileForTitle: Before searching for a doc or mail template
- $title: Title we're looking for
- &$paths: Paths we're searching
- &$filename: Filename so far (set this if you want)
EndDocFileForTitle: After searching for a doc or mail template
- $title: Title we looked for
- $paths: Paths we searched
- &$filename: Filename so far (set this if you want)
2011-05-07 01:18:38 +01:00
StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
- &$tables: list of table names
- &$rwdb: read-write database URI
EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
- $tables: list of table names
- $rwdb: read-write database URI
2011-05-10 01:07:36 +01:00
StartShowInviteForm: Right before displaying the invitations form
- $action: invitation action
EndShowInviteForm: After displaying the invitations form
- $action: invitation action
StartSendInvitations: Right before sending invitations
- $action: invitation action
EndSendInvitations: Right after sending invitations
- $action: invitation action
StartShowInvitationSuccess: Right before showing invitations success msg
- $action: invitation action
EndShowInvitationSuccess: After showing invitations success msg
- $action: invitation action
2011-09-15 22:05:32 +01:00
StartUpgrade: when starting a site upgrade
EndUpgrade: when ending a site upgrade; good place to do your own upgrades
2011-09-21 20:15:59 +01:00
HaveIMPlugin: is there an IM plugin loaded?
- &$haveIMPlugin: set me to true if you're loaded!
2012-03-08 12:58:45 +00:00
StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
- $nli: NoticeListItem being shown
EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
- $nli: NoticeListItem being shown
2012-03-20 20:38:56 +00:00
StartNoticeInScope: Before checking if a notice should be visible to a user
- $notice: The notice to check
- $profile: The profile to check for scope
- &$bResult: The boolean result; fill this in if you want to skip
EndNoticeInScope: After checking if a notice should be visible to a user
- $notice: The notice to check
- $profile: The profile to check for scope
- &$bResult: The boolean result; overwrite this if you so desire
2012-03-21 13:26:35 +00:00
StartNoticeListPrefill: Before pre-filling a list of notices with extra data
- &$notices: Notices to be pre-filled
- $avatarSize: The avatar size for the list
EndNoticeListPrefill: After pre-filling a list of notices with extra data
- &$notices: Notices that were pre-filled
- &$profiles: Profiles that were pre-filled
- $avatarSize: The avatar size for the list
2012-03-20 20:38:56 +00:00
2012-07-09 17:55:05 +01:00
OtherAccountProfiles: Hook to add account profiles to a user account profile block
- $profile: the Profile being shown
- &$others: Modifiable array of profile info arrays. Each one has the following fields:
href: link to the profile
text: text for the profile
image: mini image for the profile
2014-04-16 18:14:26 +01:00
2014-04-21 11:33:41 +01:00
CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
2014-04-21 19:39:28 +01:00
- $file: 'File' object to source the image from
2014-04-16 18:14:26 +01:00
- &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
- $media: MIME media type ('image', 'video', 'audio' etc.)
2014-05-06 20:49:42 +01:00
2014-06-05 11:59:38 +01:00
StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
- $imagefile: ImageFile object we're resizing.
- $outpath: string with output filepath
- $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
2015-03-02 19:37:59 +00:00
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.)
2014-05-06 20:49:42 +01:00
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.
EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
- $out: HTMLOutputter class to use for outputting HTML.
- $file: 'File' object which we're going to show representation for.
ShowUnsupportedAttachmentRepresentation: 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.
2014-07-06 15:37:26 +01:00
StartNotifyMentioned: 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.
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.
2015-02-13 15:26:41 +00:00
StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home'
2015-02-14 16:35:34 +00:00
- $out: HTMLOutputter used to output (usually an Action, but not always!)
- &$items: Referenced array of items in the nav (add if desired)
2015-02-13 15:26:41 +00:00
EndHomeStubNavItems:
2015-02-14 16:35:34 +00:00
- $out: HTMLOutputter used to output (usually an Action, but not always!)
- $items: array of menu items
2015-02-13 15:26:41 +00:00
2015-02-14 16:37:35 +00:00
StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML
2015-02-14 16:32:35 +00:00
- $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.
2015-02-14 16:37:35 +00:00
EndSubMenu: After outputting a submenu (including enclosing tags) to HTML
2015-02-14 16:32:35 +00:00
- $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.
2015-02-24 20:51:31 +00:00
StartDocNav: Before outputting the docs Nav
- $nav: The DoclNav widget
EndDocNav: After outputting the docs Nav
- $nav: The DoclNav widget
