From 76bea966f7f93e719ccbf6e2350f647636d4da2a 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/advanced.php | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

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

diff --git a/documentation/examples/events/advanced.php b/documentation/examples/events/advanced.php
index 22a407579..73edea9da 100644
--- a/documentation/examples/events/advanced.php
+++ b/documentation/examples/events/advanced.php
@@ -1,10 +1,13 @@
 <?php
+/**
+ * This snippets demonstrates how returning false changes the normal operation
+ * of Elgg.
+ */
 
 elgg_register_event_handler('create', 'object', 'example_event_handler');
 
-function example_event_handler($event, $type, $params) {
+function example_event_handler($event, $type, $object) {
 	// Don't allow any non-admin users to create objects
 	// Returning false from this function will halt the creation of the object.
 	return elgg_is_admin_logged_in();
 }
-
-- 
cgit v1.2.3