DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:events_list

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
devel:events_list [2009-03-29 21:39] efegedevel:events_list [2016-12-17 10:35] (current) Aleksandr
Line 1: Line 1:
 ====== Event Reference List ====== ====== 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]].+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. 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 ---- ---- datatable ----
-cols    : %title%, description, preventable, added_dt +headers : Event Name, Description, Preventable, Added, Removed 
-headers : Event Name, Description, Preventable, Added+cols    : %title%, Description, Preventable, Added_dt, Removed_dt
 sort    : %title% sort    : %title%
 filter  : %pageid% ~ devel:event:* filter  : %pageid% ~ devel:event:*
 ---- ----
  
-==== Naming Structure ====+===== Naming Structure =====
  
 Event names follow a standard structure: Event names follow a standard structure:
  
-  <location>_<event_data>_<action>+  <location>_<event_data>_<action_or_state>
  
   * ''<location>'' --- short name or hint which identifies the part of DokuWiki which generates the event.   * ''<location>'' --- short name or hint which identifies the part of DokuWiki which generates the event.
Line 24: Line 24:
 Examples: Examples:
  
-  * parser_handler_done+  * PARSER_HANDLER_DONE
     * the event is triggered in the **parser** scripts,      * the event is triggered in the **parser** scripts, 
     * the **handler** object is the event data,     * 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.     * 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+  * ACTION_HEADERS_SEND
     * the event is triggered in **action**s.php,     * the event is triggered in **action**s.php,
     * the event data is an array of **headers**,     * the event data is an array of **headers**,
     * the default action is to **send** the 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]]
devel/events_list.1238355547.txt.gz · Last modified: 2010-01-08 14:02 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki