Plugin events ordered by category

Admin area

Name When
AddItemFormExtras Somewhere inside the add item page or bookmarklet. Here, plugins can add their custom fields without having to alter one of the .template files.
AdminPrePageFoot On admin area pages, immediately before the page footer is printed.
AdminPrePageHead On admin area pages, immediately before the page head is printed. This event could be used to add extra script/css includes in the head section
BlogSettingsFormExtras On the blog settings page. You can add your own forms here.
BookmarkletExtraHead Somewhere inside the head section of the bookmarklet XHTML code.
EditItemFormExtras Somewhere inside the edit item page or bookmarklet. Here, plugins can add their custom fields without having to alter one of the .template files.
GeneralSettingsFormExtras On the general settings page. You can add your own forms here.
MemberSettingsFormExtras On the member settings page. You can add your own forms here.
PreAddItemForm Immediately before an add item form (bookmarklet or admin area) is created.
QuickMenu At the end of the Admin Area quick menu. This can be used to add extra plugin entries. To add entries, push associative arrays on the options array. An example can be found in the section about creating a plugin admin area.

Ban

Name When
PostAddBan Immediately after a new ban has been added
PostDeleteBan Immediately after an IP ban has been deleted from the database
PreAddBan Immediately before a new ban is added to a weblog
PreDeleteBan Immediately before an IP ban gets deleted from the database

Blog

Name When
PostAddBlog Immediately after a new blog has been created
PostBlogContent After blog content has been inserted through a skinvar
PostDeleteBlog Immediately after a blog has been deleted from the database
PreAddBlog Immediately before a new blog is created
PreBlogContent Before blog content has been inserted through a skinvar
PreDeleteBlog Immediately before a blog gets deleted from the database

Category

Name When
PostAddCategory Immediately after a new category has been created in the database
PostDeleteCategory Immediately after a category has been deleted from the database
PostMoveCategory Immediately after a catgeory has been moved to another blog
PreAddCategory Immediately before a new category is created in the database
PreDeleteCategory Immediately before a category gets deleted from the database
PreMoveCategory Immediately before a catgeory is moved to another blog

Comment

Name When
PostAddComment After adding a comment to the database
PostComment After a comment has been shown
PostDeleteComment Immediately after a comment has been deleted from the database
PreAddComment Before adding a comment to the database
PreComment Before a comment is shown
PreDeleteComment Immediately before a comment gets deleted from the database
PrepareCommentForEdit After a comment is retrieved from the database, and before it is presented to the user to be edited.
PreUpdateComment Immediately before a comment is updated and saved into the database

Date

Name When
PostDateFoot After a date footer has been parsed
PostDateHead After a date header has been parsed
PreDateFoot Before a date footer is parsed
PreDateHead Before a date header is shown

Forms

Name When
FormExtra Inside one of the comment, membermail or account activation forms. This event allows plugins to insert extra fields in the form. This event corresponds with the ValidateForm event that is fires when the form is handled.
ValidateForm Called when one of the comment, membermail or account activation forms is being handled. This event allows plugins to perform their own validation on the data, and prevent further handling if something is wrong. When used together with the FormExtra field, it can be used to add extra fields to forms.

Item

Name When
PostAddItem After an item has been added to the database
PostDeleteItem Immediately after an item has been deleted in the database
PostItem After an item has been parsed, but before the item footer has been parsed
PostMoveItem Immediately after an item has been moved to another blog/category
PreAddItem Immediately before an item is added to the database
PreDeleteItem Immediately before an item gets deleted in the database
PreItem Before an item is parsed, but after the item header has been placed
PreMoveItem Immediately before an item is moved to another blog/category
PrepareItemForEdit Called after getting an item from the database, and before presenting it to the user to be edited.
PreUpdateItem Immediately before an item gets updates in the database

Login and Authentication

Name When
LoginFailed After a failed login
LoginSuccess After a successful login
Logout After logout
PostAuthentication After the login procedure has been completed. This occurs on each page request.

Member

Name When
PostAddTeamMember Immediately after a member has been added to a blog team
PostDeleteMember Immediately after a member has been deleted from the database
PostDeleteTeamMember Immediately after a member has been deleted from a weblog team
PostRegister After a new user has registered
PreAddTeamMember Immediately before a member gets added to a blog team
PreDeleteMember Immediately before a member gets deleted from the database
PreDeleteTeamMember Immediately before a member gets deleted from a weblog team

Parser

Name When
PostSkinParse Immediately after parsing a skin
PreSkinParse Immediately before the parsing of a skin begins

Plugin

Name When
PostAddPlugin Immediately after a plugin has been added
PostDeletePlugin Immediately after a plugin has been deleted from the database
PostPluginOptionsUpdate After the options for a plugin have been updated.
PreAddPlugin Immediately before a plugin is added
PreDeletePlugin Immediately before a plugin gets deleted from the database
PrePluginOptionsEdit Before the 'edit plugin options' form is created.
PrePluginOptionsUpdate Before the options for a plugin have been updated. (using this event you can validate/change the new value for an option)

Skin

Name When
PostAddSkin Immediately after a new skin has been created
PostDeleteSkin Immediately after a skin has been deleted from the database
PreAddSkin Immediately before a new skin is created (note: this one also gets called when a skin is cloned))
PreDeleteSkin Immediately before a skin gets deleted from the database

Template

Name When
PostAddTemplate Immediately after a new template has been created
PostDeleteTemplate Immediately after a template has been deleted from the database
PreAddTemplate Immediately before a new template is created (note: this one also gets called when a template is cloned))
PreDeleteTemplate Immediately before a template gets deleted from the database

URL Manipulation

Name When
ParseURL Before an URL is interpreted by the system
GenerateURL Before an URL is generated by the system

Misc

Name When
ActionLogCleared After the action log has been cleared
PreSendContentType Immediately before a content type is being set in the HTTP header
plugindev/event_by_category.txt · Last modified: 2006/07/05 13:03 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki