From a892d01721e2730badadc885d1adb089fdde4557 Mon Sep 17 00:00:00 2001 From: ben Date: Fri, 28 Mar 2008 13:51:44 +0000 Subject: Some extra documentation git-svn-id: https://code.elgg.org/elgg/trunk@277 36083f99-b078-4883-b0ff-0f9b5a30f544 --- engine/lib/elgglib.php | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'engine') diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php index 63de9d1b5..c711dd879 100644 --- a/engine/lib/elgglib.php +++ b/engine/lib/elgglib.php @@ -615,6 +615,13 @@ * * "all" is a valid value for both $hook and $entity_type. "none" is a valid value for $entity_type. * + * The export_user function would then be defined as: + * + * function export_user($hook, $entity_type, $returnvalue, $params); + * + * Where $returnvalue is the return value returned by the last function returned by the hook, and + * $params is an array containing a set of parameters (or nothing). + * * @param string $hook The name of the hook * @param string $entity_type The name of the type of entity (eg "user", "object" etc) * @param string $function The name of a valid function to be run @@ -648,6 +655,7 @@ /** * Triggers a plugin hook, with various parameters as an array. For example, if you're * + * @see register_plugin_hook * @param string $hook The name of the hook to trigger * @param string $entity_type The name of the entity type to trigger it for (or "all", or "none") * @param array $params Any parameters. It's good practice to name the keys, i.e. by using array('name' => 'value', 'name2' => 'value2') -- cgit v1.2.3