====== Event Reference List ======

The following is a list of all events implemented by the DokuWiki's [[devel:event|event system]] for the use with [[devel:action plugins]]. To be able to choose the correct event a look at the [[overview|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 [[develonly|development version]] of DokuWiki.

---- datatable ----
headers : Event Name, Description, Preventable, Added, Removed
cols    : %title%, Description, Preventable, Added_dt, Removed_dt
sort    : %title%
filter  : %pageid% ~ devel:event:*
----

===== 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 **action**s.php,
    * the event data is an array of **headers**,
    * the default action is to **send** the headers.


===== See also =====

  * The [[devel:event|event system]]
  * Use [[devel:Action plugins]] to register handlers on events.
  * More about [[Event handlers]]
  * Examples of [[event handlers code]]