- $action: action object being shown
StartPersonalGroupNav: beginning of personal group nav menu
-- $action: action object being shown
+- $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
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
EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
- $item: the NoticeListItem object being shown
-StartShowFaveForm: just before showing the fave form
-- $item: the NoticeListItem object being shown
-
-EndShowFaveForm: just after showing the fave form
-- $item: the NoticeListItem object being shown
-
StartShowPageNotice: just before showing the page notice (instructions or error)
- $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 text entry fields on email settings page
-- $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 text entry fields on email settings page
+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
-- &$user: user being saved
+- $scoped: Profile user having their email settings saved
EndEmailSaveForm: after saving a email settings form (after commit)
- $action: action object being shown
-- &$user: user being saved
+- $scoped: Profile user having their email settings saved
StartRegistrationFormData: just before showing text entry fields on registration page
- $action: action object being shown
- $user: user
StartSetApiUser: Before setting the current API user
-- $user: user
+- &$user: user, can be set during event handling (return false to stop processing)
EndSetApiUser: After setting the current API user
-- $user: user
+- $user: user, only called if this is an actual user
StartHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $profile: Profile of user we want to get acct: URI for
- &$acct: string with the resulting acct: uri
-StartFavorNotice: Saving a notice as a favorite
-- $profile: profile of the person faving (can be remote!)
-- $notice: notice being faved
-- &$fave: Favor object; null to start off with, but feel free to override.
-
-EndFavorNotice: After saving a notice as a favorite
-- $profile: profile of the person faving (can be remote!)
-- $notice: notice being faved
-
-StartDisfavorNotice: Saving a notice as a favorite
-- $profile: profile of the person faving (can be remote!)
-- $notice: notice being faved
-- &$result: result of the disfavoring (if you override)
-
-EndDisfavorNotice: After saving a notice as a favorite
-- $profile: profile of the person faving (can be remote!)
-- $notice: notice being faved
-
-StartFavorNoticeForm: starting the data in the form for favoring a notice
-- $FavorForm: the favor form being shown
-- $notice: notice being favored
-
-EndFavorNoticeForm: Ending the data in the form for favoring a notice
-- $FavorForm: the favor form being shown
-- $notice: notice being favored
-
-StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
-- $DisfavorForm: the disfavor form being shown
-- $notice: notice being difavored
-
-EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
-- $DisfavorForm: the disfavor form being shown
-- $notice: notice being disfavored
-
StartFindMentions: start finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
- &$activity: received activity
-- $user: user publishing the entry
+- $profile: profile of the user publishing the entry
- &$notice: notice created; initially null, can be set
EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
- $activity: received activity
-- $user: user publishing the entry
+- $profile: profile of the user publishing the entry
- $notice: notice that was created
AdminPanelCheck: When checking whether the current user can access a given admin panel
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.
+
+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.
projects / quix0rs-gnu-social.git / blobdiff