DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== ACTION_HANDLE_SUBSCRIBE ======

---- dataentry event ----
Description:    handle, process & generate data for a subscribe request
DefaultAction:  subscription style, target and action are validated and data (time) is generated
Preventable:    yes
Added_dt:       2010-01-20
----

This event is signaled by [[xref>act_subscription()]] in [[xref>inc/actions.php]] when receiving a subscribe request, handlers can use it to allow different subscription styles, targets and actions.

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

The ''$data'' field is an array with the entries:

* $data['target'] -- Target page or namespace ID; Namespaces are denoted by a trailing '':''.
  * $data['style'] -- Subscription style; core allows 'every' and 'digest' for pages and namespaces, and 'list' for namespaces.
  * $data['action'] -- Subscription action; core knows ''subscribe'' and ''unsubscribe''.

===== 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.

* none

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

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

Please fill all the letters into the box to prove you're human. D Y A G E Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International