From 11aacb4f048e659d1b86a6ba229438444a186142 Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Sat, 12 Nov 2011 14:28:52 -0500
Subject: added better plugin skeleton and added documentation to some of the
 examples

---
 documentation/examples/events/basic.php | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

(limited to 'documentation/examples/events/basic.php')

diff --git a/documentation/examples/events/basic.php b/documentation/examples/events/basic.php
index 91704e60b..ca2762344 100644
--- a/documentation/examples/events/basic.php
+++ b/documentation/examples/events/basic.php
@@ -1,13 +1,17 @@
 <?php
+/**
+ * This snippet demonstrates how to register for an event. It dumps the
+ * parameters that the handler receives to the screen. The third argument
+ * of the handler function is an object that is related to the event. For
+ * the 'init', 'system' eveny, it is null.
+ */
 
 elgg_register_event_handler('init', 'system', 'example_event_handler');
 
-function example_event_handler($event, $type, $params) {
+function example_event_handler($event, $type, $object) {
 	var_dump($event);
-	var_dump($object_type);
-	var_dump($params);
+	var_dump($type);
+	var_dump($object);
 
 	return true;
 }
-
-
-- 
cgit v1.2.3