diff options
Diffstat (limited to 'documentation/examples/hooks/basic.php')
| -rw-r--r-- | documentation/examples/hooks/basic.php | 41 | 
1 files changed, 12 insertions, 29 deletions
diff --git a/documentation/examples/hooks/basic.php b/documentation/examples/hooks/basic.php index 71076ee96..734d9e884 100644 --- a/documentation/examples/hooks/basic.php +++ b/documentation/examples/hooks/basic.php @@ -1,34 +1,17 @@  <?php +/** + * The handler for a plugin hook receives information about the hook (name and + * type), the current value for the hook, and parameters related to the hook. + */ -elgg_register_plugin_hook_handler('get_items', 'example', 'example_plugin_hook'); -elgg_register_plugin_hook_handler('get_items', 'example', 'example_plugin_hook_2'); +elgg_register_plugin_hook_handler('forward', '404', 'example_plugin_hook_handler'); -$params = array('username' => 'Joe'); -$items = elgg_trigger_plugin_hook('get_items', 'example', $params, $default); +function example_plugin_hook_handler($hook, $type, $value, $params) { +	var_dump($hook); +	var_dump($type); +	var_dump($value); +	var_dump($params); -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_2($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; +	// we are not changing $value so return null +	return null;  }  | 
