Better trigger_plugin_hook documentation.

git-svn-id: https://code.elgg.org/elgg/trunk@2563 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 5 insertions, 1 deletions

diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index de2329f4a..3bdb6d650 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -1475,7 +1475,11 @@
 		}
 		
 	/**
-	 * Triggers a plugin hook, with various parameters as an array. For example, if you're 
+	 * Triggers a plugin hook, with various parameters as an array. For example, to provide

+	 * a 'foo' hook that concerns an entity of type 'bar', with a parameter called 'param1'

+	 * with value 'value1', that by default returns true, you'd call:

+	 * 

+	 * trigger_plugin_hook('foo', 'bar', array('param1' => 'value1'), true);
 	 *
 	 * @see register_plugin_hook
 	 * @param string $hook The name of the hook to trigger