Differences

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

--- devel:event:action_handle_subscribe [2010-03-10 12:12] – created adrianlang
+++ devel:event:action_handle_subscribe [2018-12-08 14:52] (current) – doc updated according to issue #2615 torpedo
@@ Line 11: / Line 11: @@
 ===== Passed Data =====
+The passed [[xref>Doku_Event]] object has the fields: ''$data'' and ''$result''.
-  * $data['target']: Target page or namespace ID; Namespaces are denoted by a trailing ':'.
+The ''$data'' field is an array with the entries:
-  * $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 =====
+  * $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''.
-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.
+In the BEFORE event handler you can modify the ''$data'' field and eventually you can use here ''preventDefault()'' to skip execution of DokuWiki's default [[xref>subscription_handle_post()]].
-  * none
+The ''$result'' field is always null because this event has no default action that sets this field. The AFTER event handler let you process the ''$data'' field further after the default processing.
 ===== See also =====
+  * [[codesearch>ACTION_HANDLE_SUBSCRIBE|Code related to this event]] used in any DokuWiki's files, plugins and templates
   * [[devel:Action Plugins]]
   * [[devel:Events]]