DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

devel:events_list

Event Reference List

The following is a list of all events implemented by the DokuWiki's event system for the use with action plugins. To be able to choose the correct event a look at the walk through the source code during a request for /doku.php?id=start&do=show to explain the basics of DokuWiki.

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 NameDescriptionPreventableAddedRemoved
ACTION_ACT_PREPROCESSHandling ?do= actionsyes2006-04-25
ACTION_EXPORT_POSTPROCESSpostprocess the output of a page requested for exportno2008-08-28
ACTION_HANDLE_SUBSCRIBEhandle, process & generate data for a subscribe requestyes2010-01-20
ACTION_HEADERS_SENDmodify the HTTP headers sent by Dokuwikiyes2006-04-25
ACTION_SHOW_REDIRECTintercept redirects after postsyes2008-10-26
AJAX_CALL_UNKNOWNHandle AJAX callsyes2006-08-09
AUTH_ACL_CHECKWraps around checking the ACLs for a user on a given page or namespaceyes2014-01-19
AUTH_LOGIN_CHECKintercept requests before authenticationyes2009-03-13
AUTH_PASSWORD_GENERATEModify how new user passwords are generatedyes2013-06-16
AUTH_USER_CHANGEIntercept user data modifications before they are sent to the auth backendyes2008-08-17
COMMON_NOTIFY_ADDRESSLISTManipulate the address list for a subscription mail notification after an edityes2010-01-20
COMMON_PAGETPL_LOADenhance or replace namespace templatesyes2011-02-03
COMMON_PAGE_FROMTEMPLATEenhance or replace namespace templatesyes2010-03-102011-02-03
COMMON_USER_LINKLets modify/replace the user interwiki linkyes2014-03-16
COMMON_WIKIPAGE_SAVEIntercept or modify saving of a wiki pageyes2016-02-24
COMMON_WORDBLOCK_BLOCKEDIntercept wordblockyes2008-10-12
CONFUTIL_CDN_SELECTPick the URLs to load scripts from depending on the jquerycdn settingyes2017-02-03
DETAIL_STARTEDThe image detail page prepares to do its workno2012-09-10
DOKUWIKI_DONErun some code after DokuWiki finished all its processingno2006-04-25
DOKUWIKI_STARTEDDokuWiki prepares to do its workno2006-04-25
FEED_DATA_PROCESSProcess the feed data into feed itemsyes2009-11-10
FEED_ITEM_ADDManipulate RSS feed itemsyes2007-07-18
FEED_MODE_UNKNOWNAn unknown feed mode was requestedyes2009-11-10
FEED_OPTS_POSTPROCESSCan modify the parameters for the feed creationno2009-11-10
FETCH_MEDIA_STATUShandles status codes when downloading a media resourceyes2010-02-23
FULLTEXT_SNIPPET_CREATESearch result snippet creationyes2009-10-26
HTML_CONFLICTFORM_OUTPUTmodify the conflict handling HTMLno2007-07-30
HTML_DRAFTFORM_OUTPUTmodify the draft recovery HTMLno2007-07-30
HTML_EDITFORM_OUTPUTmodify the edit form HTMLno2007-07-30
HTML_EDIT_FORMSELECTIONadd elements to edit forms for editing the given wikitextyes2010-01-19
HTML_LOGINFORM_OUTPUTmodify the login form HTMLno2007-07-30
HTML_PAGE_FROMTEMPLATEreplace namespace templates functionalityyes2006-09-162010-03-10
HTML_RECENTFORM_OUTPUTmodify the recent changes HTMLno2008-10-12
HTML_REGISTERFORM_OUTPUTmodify the register form HTMLno2007-07-30
HTML_RESENDPWDFORM_OUTPUTmodify the resend password HTMLno2007-07-30
HTML_REVISIONSFORM_OUTPUTmodify the old revisions HTMLno2008-10-12
HTML_SECEDIT_BUTTONprepares section edit button data for event triggering used as a callback in html_secedityes2010-11-07
HTML_SHOWREV_OUTPUTmodify the showrev warning HTMLyes2015-02-19
HTML_SUBSCRIBEFORM_OUTPUTmodify the subscribe form HTMLno2010-01-20
HTML_UPDATEPROFILEFORM_OUTPUTmodify the update profile HTMLno2007-07-30
HTML_UPLOADFORM_OUTPUTmodify the uploadform HTMLno2008-10-29
HTTPCLIENT_REQUEST_SENDrewrite outgoing HTTP(s) requestsyes2009-03-13
INDEXER_PAGE_ADDmanipulate the full text indexing processyes2007-02-27
INDEXER_TASKS_RUNrun custom "Cron jobs"yes2008-02-26
INDEXER_TEXT_PREPAREPage tokenizing (aka. splitting the text into separate words)yes2011-03-19
INDEXER_VERSION_GETConstruct the version number of the indexerno2011-03-06
INIT_LANG_LOADmanipulate the loading of the main language filesyes2012-03-10
IO_NAMESPACE_CREATEDcatch namespace creationsno2006-07-05
IO_NAMESPACE_DELETEDcatch namespace deletionsno2006-07-05
IO_WIKIPAGE_READintercept reading the raw wiki text datano2006-07-05
IO_WIKIPAGE_WRITEintercept page writesno2006-07-05
JS_CACHE_USEmanipulate the JavaScript cacheyes2012-03-10
JS_SCRIPT_LISTmanipulate the list of JavaScripts that will be concatenatedno2017-02-14
MAIL_MESSAGE_SENDmanage mail sending from DokuWikiyes2007-09-30
MEDIAMANAGER_CONTENT_OUTPUTWraps the output of the (right) content pane in the Media Manageryes2009-08-30
MEDIAMANAGER_STARTEDThe media manager prepares to do its workno2008-12-10
MEDIA_DELETE_FILEIntercept file deletionyes2008-10-01
MEDIA_SENDFILEmanipulate media file downloads from the wikiyes2008-06-23
MEDIA_UPLOAD_FINISHexecute an action on file uploadsyes2007-09-09
PAGEUTILS_ID_HIDEPAGEchecks if a page is hiddenyes2012-11-05
PARSER_CACHE_USEmanipulate the cache validityyes2006-09-16
PARSER_HANDLER_DONEfinalize instruction datano2006-05-22
PARSER_METADATA_RENDERmanipulate metadatayes2006-11-26
PARSER_WIKITEXT_PREPROCESSmanipulate raw wiki textno2006-07-24
PLUGIN_CONFIG_PLUGINLISTAllow modification of the plugin list used by the config pluginno2009-01-19
PLUGIN_PLUGINMANAGER_PLUGINLISTAllow modification of the plugin list used by the config pluginno2009-01-19
PLUGIN_POPULARITY_DATA_SETUPTriggered by the popularity plugin to let plugins add their own popularity datano2015-05-27
RENDERER_CONTENT_POSTPROCESSPostprocess renderer outputno2006-07-24
RPC_CALL_ADDMap custom RPC call to existing one.no2012-03-23
SEARCH_QUERY_FULLPAGEFilter/reorder search resultsyes2008-08-11
SEARCH_QUERY_PAGELOOKUPFilter/reorder search resultsyes2008-08-11
SITEMAP_GENERATEGenerate a sitemap XML file from sitemap itemsyes2010-11-12
SITEMAP_PINGPing search engines with the sitemap URLyes2010-11-12
TEMPLATE_PAGETOOLS_DISPLAYLets the pagetools in supported templates be modified.yes2013-11-18
TEMPLATE_SITETOOLS_DISPLAYLets the sitetools in supported templates be modified.yes2013-11-18
TEMPLATE_USERTOOLS_DISPLAYLets the usertools in supported templates be modified.yes2013-11-18
TOOLBAR_DEFINEAdd buttons to the toolbaryes2007-02-27
TPL_ACTION_GETAdd or modify action link propertiesyes2015-08-05
TPL_ACT_RENDEROutput XHTML before and/or after a pageyes2006-04-25
TPL_ACT_UNKNOWNOutput XHTML in the main DokuWiki windowyes2006-04-25
TPL_CONTENT_DISPLAYPost process the XHTML outputyes2006-04-25
TPL_IMG_DISPLAYThe image output on an image detail pageyes2010-06-26
TPL_METAHEADER_OUTPUTManipulate meta headersyes2006-09-16
TPL_TOC_RENDERPre-/postprocess the TOCno2008-08-30
XMLRPC_CALLBACK_REGISTERAdd XML-RPC callbacksyes2008-08-24

Naming Structure

Event names follow a standard structure:

<location>_<event_data>_<action_or_state>
  • <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.

Examples:

  • 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.

See also

devel/events_list.txt · Last modified: 2016-12-17 10:35 by Aleksandr