From 464e7b7109635979388d52ade5acebfbd0b22a9b Mon Sep 17 00:00:00 2001 From: Bob Vincent Date: Fri, 17 Jun 2011 16:09:18 -0400 Subject: [PATCH] Issue #1192178 by pillarsdotnet: Document parameters to user_module_invoke() function. --- modules/user/user.module | 11 +++++++++++ 1 files changed, 11 insertions(+), 0 deletions(-) diff --git a/modules/user/user.module b/modules/user/user.module index ffd170c458159285dd8256c0ebd0f6e083aa441f..a550f58d812b74909e51a63d35805e2bb43622eb 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -78,6 +78,17 @@ function user_help($path, $arg) { * * We cannot use module_invoke() for this, because the arguments need to * be passed by reference. + * + * @param $type + * The name of the user hook to invoke. + * @param $edit + * An associative array variable containing form values to be passed + * as the first parameter of the hook function. + * @param $account + * The user account object to be passed as the second parameter of the hook + * function. + * @param $category + * The category of user information being acted upon. */ function user_module_invoke($type, &$edit, $account, $category = NULL) { foreach (module_implements('user_' . $type) as $module) { -- 1.7.4.1