====== PARSER_CACHE_USE ======

---- dataentry event ----
Description:    manipulate the cache validity
DefaultAction:  determine whether or not cached data should be used
Preventable:    yes
Added_dt:       2006-09-16
----

Signalled by cache versions of parser wrapper functions [[xref>inc/parserutils.php]]. Syntax plugins can use this event to provide their own assistance to DokuWiki's cache validity logic when the syntax extension adds other dependencies to the rendered page.

===== Passed Data =====

$data is a cache object -- refer [[xref>inc/cache.php]].

For handling the event, key properties of the cache object are:

  * page, if present the wiki page id, may not always be present, e.g. when called for locale XHTML files
  * file, source file
  * mode, renderer mode (e.g. 'XHTML') or 'i' for instructions
  * depends, array of dependencies used to determine cache validity

===== Plugins handling this event =====

The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself.

  * [[plugin:dokuwikifck]], [[plugin:htmlokay]], [[plugin:include]], [[plugin:indexmenu]], [[plugin:indexmenu2]], [[plugin:navi]], [[plugin:prolog]], [[plugin:qstat]], [[plugin:randominc]], [[plugin:source]]

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

  * [[devel:Action Plugins]]
  * [[devel:Events]]