Event Reference List

The following is a list of all events implemented by the DokuWiki's event system for the use with action plugins.

When writing a new plugin, be sure to check when a event was added. Some might be only available in a recent development version of DokuWiki.

↓ Event Name	Description	Preventable	Added
ACTION_ACT_PREPROCESS	Handling ?do= actions	yes	2006-04-25
ACTION_EXPORT_POSTPROCESS	postprocess the output of a page requested for export	no	2008-08-28
ACTION_HEADERS_SEND	modify the HTTP headers sent by Dokuwiki	yes	2006-04-25
ACTION_SHOW_REDIRECT	intercept redirects after posts	yes	2008-10-26
AJAX_CALL_UNKNOWN	Handle AJAX calls	yes	2006-08-09
AUTH_USERDATA_CHANGE	Intercept user data modifications before they are sent to the auth backend	yes	2008-08-17
COMMON_WORDBLOCK_BLOCKED	Intercept wordblock	yes	2008-10-12
DOKUWIKI_DONE	run some code after DokuWiki finished all its processing	no	2006-04-25
DOKUWIKI_STARTED	DokuWiki prepares to do its work	no	2006-04-25
FEED_ITEM_ADD	Manipulate RSS feed items	yes	2007-07-18
HTML_CONFLICTFORM_OUTPUT	modify the conflict handling HTML	no	2007-07-30
HTML_DRAFTFORM_OUTPUT	modify the draft recovery HTML	no	2007-07-30
HTML_EDITFORM_OUTPUT	modify the edit form HTML	no	2007-07-30
HTML_LOGINFORM_OUTPUT	modify the login form HTML	no	2007-07-30
HTML_PAGE_FROMTEMPLATE	replace namespace templates functionality	yes	2006-09-16
HTML_RECENTFORM_OUTPUT	modify the recent changes HTML	no	2008-10-12
HTML_REGISTERFORM_OUTPUT	modify the register form HTML	no	2007-07-30
HTML_RESENDPWDFORM_OUTPUT	modify the resend password HTML	no	2007-07-30
HTML_REVISIONSFORM_OUTPUT	modify the old revisions HTML	no	2008-10-12
HTML_UPDATEPROFILEFORM_OUTPUT	modify the update profile HTML	no	2007-07-30
HTML_UPLOADFORM_OUTPUT	modify the uploadform HTML	no	2008-10-29
INDEXER_PAGE_ADD	manipulate the full text indexing process	yes	2007-02-27
INDEXER_TASKS_RUN	run custom "Cron jobs"	yes	2008-02-26
IO_NAMESPACE_CREATED	catch namespace creations	no	2006-07-05
IO_NAMESPACE_DELETED	catch namespace deletions	no	2006-07-05
IO_WIKIPAGE_READ	intercept reading the raw wiki text data	no	2006-07-05
IO_WIKIPAGE_WRITE	intercept page writes	no	2006-07-05
MAIL_MESSAGE_SEND	manage mail sending from DokuWiki	yes	2007-09-30
MEDIA_DELETE_FILE	Intercept file deletion	yes	2008-10-01
MEDIA_SENDFILE	manipulate media file downloads from the wiki	yes	2008-06-23
MEDIA_UPLOAD_FINISH	execute an action file uploads	yes	2007-09-09
PARSER_CACHE_USE	manipulate the cache validity	yes	2006-09-16
PARSER_HANDLER_DONE	finalize instruction data	no	2006-05-22
PARSER_METADATA_RENDER	manipulate metadata	yes	2006-11-26
PARSER_WIKITEXT_PREPROCESS	manipulate raw wiki text	no	2006-07-24
RENDERER_CONTENT_POSTPROCESS	Postprocess renderer output	no	2006-07-24
SEARCH_QUERY_FULLPAGE	Filter/reoderder search results	yes	2008-08-11
SEARCH_QUERY_PAGELOOKUP	Filter/reoderder search results	yes	2008-08-11
TOOLBAR_DEFINE	Add buttons to the toolbar	yes	2007-02-27
TPL_ACT_RENDER	Output XHTML before and/or after a page	yes	2006-04-25
TPL_ACT_UNKNOWN	Output XHTML in the main DokuWiki window	yes	2006-04-25
TPL_CONTENT_DISPLAY	Post process the XHTML output	yes	2006-04-25
TPL_METAHEADER_OUTPUT	Manipulate meta headers	yes	2006-09-16
TPL_TOC_RENDER	Pre-/postprocess the TOC	no	2008-08-30
XMLRPC_CALLBACK_REGISTER	Add XMLRCP callbacks	yes	2008-08-24

Naming Structure

Event names follow a standard structure:

<location>_<event_data>_<action>

<location> — short name or hint which identifies the part of DokuWiki which generates the event.
<event_data> — short name or hint which identifies the data being passed by the event
<action_or_state> — if the event has a default action, this will indicate what that action is, if there is no default action, this will indicate the state or other reason for firing the event.

e.g. parser_handler_done

the event is triggered in the parser scripts,
the handler object is the event data,
there is no action, the state of parser, in its handler step, is done, i.e., the handler has completed its processing.

action_headers_send

the event is triggered in actions.php,
the event data is an array of headers,
the default action is to send the headers.