devel:events_list
Table of Contents
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 Name | Description | Preventable | Added | Removed |
|---|---|---|---|---|
| @!FILE!@ | ||||
| ACTION_ACT_PREPROCESS | Handling ?do= actions | yes | 2006-04-25 | |
| ACTION_DENIED_TPLCONTENT | Suppress login form when access is denied | yes | 2022-01-10 | |
| ACTION_EXPORT_POSTPROCESS | postprocess the output of a page requested for export | no | 2008-08-28 | |
| ACTION_HANDLE_SUBSCRIBE | handle, process & generate data for a subscribe request | yes | 2010-01-20 | |
| 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 | |
| ADMINPLUGIN_ACCESS_CHECK | Allows to intercept and change the access to admin plugins | yes | 2018-12-10 | |
| AJAX_CALL_UNKNOWN | Handle AJAX calls | yes | 2006-08-09 | |
| AUTH_ACL_CHECK | Wraps around checking the ACLs for a user on a given page, a media or namespace | yes | 2014-01-19 | |
| AUTH_LOGIN_CHECK | intercept requests before authentication | yes | 2009-03-13 | |
| AUTH_PASSWORD_GENERATE | Modify how new user passwords are generated | yes | 2013-06-16 | |
| AUTH_USER_CHANGE | Intercept user data modifications before they are sent to the auth backend | yes | 2008-08-17 | |
| COMMON_NOTIFY_ADDRESSLIST | Manipulate the address list for a subscription mail notification after an edit | yes | 2010-01-20 | |
| COMMON_PAGETPL_LOAD | enhance or replace namespace templates | yes | 2011-02-03 | |
| COMMON_PAGE_FROMTEMPLATE | enhance or replace namespace templates | yes | 2010-03-10 | 2011-02-03 |
| COMMON_USER_LINK | Lets modify/replace the user interwiki link | yes | 2014-03-16 | |
| COMMON_WIKIPAGE_SAVE | Intercept or modify saving of a wiki page | yes | 2016-02-24 | |
| COMMON_WORDBLOCK_BLOCKED | Intercept wordblock | yes | 2008-10-12 | |
| CONFUTIL_CDN_SELECT | Pick the URLs to load scripts from depending on the jquerycdn setting | yes | 2017-02-03 | |
| CSS_CACHE_USE | manipulate the CSS cache | yes | 2017-08-01 | |
| CSS_STYLES_INCLUDED | modify or prevent the list of included CSS files | yes | 2017-08-01 | |
| DETAIL_STARTED | The image detail page prepares to do its work | no | 2012-09-10 | |
| DOKUWIKI_DONE | run some code after DokuWiki finished all its processing | no | 2006-04-25 | |
| DOKUWIKI_INIT_DONE | Fired when the DokuWiki environment has been initialized | no | 2022-04-28 | |
| DOKUWIKI_STARTED | DokuWiki prepares to do its work | no | 2006-04-25 | |
| DRAFT_SAVE | Modify draft saving | yes | 2018-07-29 | |
| EDIT_FORM_ADDTEXTAREA | add elements to edit forms for editing the given wikitext | yes | 2020-10-13 | |
| FEED_DATA_PROCESS | Process the feed data into feed items | yes | 2009-11-10 | |
| FEED_ITEM_ADD | Manipulate RSS feed items | yes | 2007-07-18 | |
| FEED_MODE_UNKNOWN | An unknown feed mode was requested | yes | 2009-11-10 | |
| FEED_OPTS_POSTPROCESS | Can modify the parameters for the feed creation | no | 2009-11-10 | |
| FETCH_MEDIA_STATUS | handles status codes when downloading a media resource | yes | 2010-02-23 | |
| FORM_CONFLICT_OUTPUT | modify the conflict handling form object | no | 2020-10-13 | |
| FORM_DRAFT_OUTPUT | modify the draft recovery form object | no | 2020-10-13 | |
| FORM_EDIT_OUTPUT | modify the edit form object | no | 2020-10-13 | |
| FORM_LOGIN_OUTPUT | modify the login form object | no | 2020-10-13 | |
| FORM_PROFILEDELETE_OUTPUT | modify the delete profile form object | no | 2020-10-13 | |
| FORM_QUICKSEARCH_OUTPUT | Adjust the quick search form | No | 2018-04-05 | |
| FORM_RECENT_OUTPUT | modify the recent changes form object | no | 2020-10-13 | |
| FORM_REGISTER_OUTPUT | modify the register form object | no | 2020-10-13 | |
| FORM_RESENDPWD_OUTPUT | modify the resend password form object | no | 2020-10-13 | |
| FORM_REVISIONS_OUTPUT | modify the old revisions form object | no | 2020-10-13 | |
| FORM_SEARCHMEDIA_OUTPUT | modify the search media form object | no | 2020-10-13 | |
| FORM_SEARCH_OUTPUT | Adjust the form on the search page | No | 2018-04-05 | |
| FORM_SUBSCRIBE_OUTPUT | modify the subscribe form object | no | 2020-10-13 | |
| FORM_UPDATEPROFILE_OUTPUT | modify the update profile form object | no | 2020-10-13 | |
| FORM_UPLOAD_OUTPUT | modify the upload form object | no | 2020-10-13 | |
| FULLTEXT_PHRASE_MATCH | Allow phrase matching with content from plugins | yes | 2014-03-02 | |
| FULLTEXT_SNIPPET_CREATE | Search result snippet creation | yes | 2009-10-26 | |
| HTML_CONFLICTFORM_OUTPUT | modify the conflict handling HTML | no | 2007-07-30 | 2020-10-13 |
| HTML_DRAFTFORM_OUTPUT | modify the draft recovery HTML | no | 2007-07-30 | 2018-07-29 |
| HTML_EDITFORM_OUTPUT | modify the edit form HTML | no | 2007-07-30 | 2020-10-13 |
| HTML_EDIT_FORMSELECTION | add elements to edit forms for editing the given wikitext | yes | 2010-01-19 | |
| HTML_LOGINFORM_OUTPUT | modify the login form HTML | no | 2007-07-30 | 2020-10-13 |
| HTML_PAGE_FROMTEMPLATE | replace namespace templates functionality | yes | 2006-09-16 | 2010-03-10 |
| HTML_PROFILEDELETEFORM_OUTPUT | modify the delete profile HTML | no | 2013-07-31 | 2020-10-13 |
| HTML_RECENTFORM_OUTPUT | modify the recent changes HTML | no | 2008-10-12 | 2020-10-13 |
| HTML_REGISTERFORM_OUTPUT | modify the register form HTML | no | 2007-07-30 | 2020-10-13 |
| HTML_RESENDPWDFORM_OUTPUT | modify the resend password HTML | no | 2007-07-30 | 2020-10-13 |
| HTML_REVISIONSFORM_OUTPUT | modify the old revisions HTML | no | 2008-10-12 | 2020-10-13 |
| HTML_SECEDIT_BUTTON | prepares section edit button data for event triggering used as a callback in html_secedit | yes | 2010-11-07 | |
| HTML_SHOWREV_OUTPUT | modify the showrev warning HTML | yes | 2015-02-19 | |
| HTML_SUBSCRIBEFORM_OUTPUT | modify the subscribe form HTML | no | 2010-01-20 | 2020-10-13 |
| HTML_UPDATEPROFILEFORM_OUTPUT | modify the update profile HTML | no | 2007-07-30 | 2020-10-13 |
| HTML_UPLOADFORM_OUTPUT | modify the uploadform HTML | no | 2008-10-29 | 2020-10-13 |
| HTTPCLIENT_REQUEST_SEND | rewrite outgoing HTTP(s) requests | yes | 2009-03-13 | |
| IMAGEMOD_CACHE_USE | manipulate the image cache | yes | 2022-02-04 | |
| INDEXER_PAGE_ADD | manipulate the full text indexing process | yes | 2007-02-27 | |
| INDEXER_TASKS_RUN | run custom "Cron jobs" | yes | 2008-02-26 | |
| INDEXER_TEXT_PREPARE | Page tokenizing (aka. splitting the text into separate words) | yes | 2011-03-19 | |
| INDEXER_VERSION_GET | Construct the version number of the indexer | no | 2011-03-06 | |
| INFOUTIL_MSG_SHOW | catch calls to msg() to record the message or modify output | yes | 2020-06-01 | |
| INFO_DEPRECATION_LOG | Log a call to a deprecated method, function or property | yes | 2018-06-05 | |
| INIT_LANG_LOAD | manipulate the loading of the main language files | yes | 2012-03-10 | |
| 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 | |
| JS_CACHE_USE | manipulate the JavaScript cache | yes | 2012-03-10 | |
| JS_SCRIPT_LIST | manipulate the list of JavaScripts that will be concatenated | no | 2017-02-14 | |
| LOGGER_DATA_FORMAT | Intercept or modify logging | yes | 2022-01-22 | |
| MAIL_MESSAGE_SEND | manage mail sending from DokuWiki | yes | 2007-09-30 | |
| MANIFEST_SEND | Change the PWA manifest sent to the client | No | 2018-04-05 | |
| MEDIAMANAGER_CONTENT_OUTPUT | Wraps the output of the (right) content pane in the Media Manager | yes | 2009-08-30 | |
| MEDIAMANAGER_STARTED | The media manager prepares to do its work | no | 2008-12-10 | |
| MEDIA_DELETE_FILE | Intercept file deletion | yes | 2008-10-01 | |
| MEDIA_RESIZE | handles media resizing or cropping | yes | 2020-06-30 | |
| MEDIA_SENDFILE | manipulate media file downloads from the wiki | yes | 2008-06-23 | |
| MEDIA_UPLOAD_FINISH | execute an action on file uploads | yes | 2007-09-09 | |
| MENU_ITEMS_ASSEMBLY | Handle the items in the various menus provided by templates | yes | 2017-09-01 | |
| PAGEUTILS_ID_HIDEPAGE | checks if a page is hidden | yes | 2012-11-05 | |
| PARSER_CACHE_USE | manipulate the cache validity | yes | 2006-09-16 | |
| PARSER_HANDLER_DONE | finalize instruction data | no | 2006-05-22 | |
| PARSER_LOCALE_XHTML | Modify localized text | yes | 2022-01-10 | |
| PARSER_METADATA_RENDER | manipulate metadata | yes | 2006-11-26 | |
| PARSER_WIKITEXT_PREPROCESS | manipulate raw wiki text | no | 2006-07-24 | |
| PLUGIN_CONFIG_PLUGINLIST | Allow modification of the plugin list used by the config plugin | no | 2009-01-19 | |
| PLUGIN_POPULARITY_DATA_SETUP | Triggered by the popularity plugin to let plugins add their own popularity data | no | 2015-05-27 | |
| RENDERER_CONTENT_POSTPROCESS | Postprocess renderer output | no | 2006-07-24 | |
| RPC_CALL_ADD | Map custom RPC call to existing one. | no | 2012-03-23 | 2024-01-12 |
| SEARCH_QUERY_FULLPAGE | Filter/reorder search results | yes | 2008-08-11 | |
| SEARCH_QUERY_PAGELOOKUP | Filter/reorder search results | yes | 2008-08-11 | |
| SEARCH_RESULT_FULLPAGE | Adjust how a fullpage search result is displayed | No | 2018-04-05 | |
| SEARCH_RESULT_PAGELOOKUP | Adjust how pagename match is displayed after search | No | 2018-04-05 | |
| SITEMAP_GENERATE | Generate a sitemap XML file from sitemap items | yes | 2010-11-12 | |
| SITEMAP_PING | Ping search engines with the sitemap URL | yes | 2010-11-12 | |
| TASK_RECENTCHANGES_TRIM | Modify the list of recent changes | no | 2018-05-17 | |
| TEMPLATE_PAGETOOLS_DISPLAY | Lets the pagetools in supported templates be modified. | yes | 2013-11-18 | 2017-09-01 |
| TEMPLATE_SITETOOLS_DISPLAY | Lets the sitetools in supported templates be modified. | yes | 2013-11-18 | 2017-09-01 |
| TEMPLATE_USERTOOLS_DISPLAY | Lets the usertools in supported templates be modified. | yes | 2013-11-18 | 2017-09-01 |
| TOOLBAR_DEFINE | Add buttons to the toolbar | yes | 2007-02-27 | |
| TPL_ACTION_GET | Add or modify action link properties | yes | 2015-08-05 | 2017-09-01 |
| 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_IMG_DISPLAY | The image output on an image detail page | yes | 2010-06-26 | |
| 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 XML-RPC callbacks | yes | 2008-08-24 | 2012-03-23 |
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
- The event system
- Use Action plugins to register handlers on events.
- More about Event handlers
- Examples of event handlers code
devel/events_list.txt · Last modified: by Aleksandr