Adding documentation and examples.

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

1 files changed, 34 insertions, 0 deletions

diff --git a/documentation/examples/hooks/basic.php b/documentation/examples/hooks/basic.php
new file mode 100644
index 000000000..fe0b847a2
--- /dev/null
+++ b/documentation/examples/hooks/basic.php
@@ -0,0 +1,34 @@
+<?php
+
+register_plugin_hook('get_items', 'example', 'example_plugin_hook');
+register_plugin_hook('get_items', 'example', 'example_plugin_hook_2');
+
+$params = array('username' => 'Joe');
+$items = trigger_plugin_hook('get_items', 'example', $params, $default);
+
+var_dump($items);
+
+function example_plugin_hook($hook, $type, $value, $params) {
+	if (is_array($value)) {
+		$value[] = "Hook Value 1";
+		$value[] = "Hook Value 2";
+	}
+
+	return $value;
+}
+
+function example_plugin_hook($hook, $type, $value, $params) {
+	$username = isset($params['username']) ? $params['username'] : NULL;
+	if (is_array($value)) {
+		switch($username) {
+			case 'Joe':
+				$value[] = "Joe's item";
+				break;
+			case 'John':
+				$value[] = "Joe's item";
+				break;
+		}
+	}
+
+	return $value;
+}