====== PLUGIN_POPULARITY_DATA_SETUP ======

---- dataentry event ----
Description:    Triggered by the popularity plugin to let plugins add their own popularity data
DefaultAction:  None. It's just used to let plugin register in order to add data
Preventable:    no
Added_dt:       2015-05-27
----

This event is signaled by [[xref>_gather()]] in [[xref>lib/plugins/popularity/helper.php]] when the popularity plugin gathers the data to send, handlers can use it to add more data.

===== Passed Data =====
The passed [[xref>Doku_Event]] object has the field: ''$data''.

  * The ''$data'' field is a key-value array passed by reference, in which plugins can add data. The key inserted should be the name of the plugin. The value inserted should be either a string, or a key-value array.

The BEFORE and AFTER events let you add entries to the ''$data'' array.


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

  * [[codesearch>PLUGIN_POPULARITY_DATA_SETUP|Code related to this event]] used in any DokuWiki's files, plugins and templates
  * [[devel:plugin_programming_tips#sending_popularity_data|Explanation and example of sending popularity data]]
  * [[devel:Action Plugins]]
  * [[devel:Events]]