Commit e1a3c1da authored by webchick's avatar webchick

Issue #1192178 by pillarsdotnet: Changed The user_module_invoke() function...

Issue #1192178 by pillarsdotnet: Changed The user_module_invoke() function lacks documentation of parameters.
parent d443880d
......@@ -74,10 +74,26 @@ function user_help($path, $arg) {
}
/**
* Invokes hook_user() in every module.
* Invokes a user hook in every module.
*
* We cannot use module_invoke() for this, because the arguments need to
* be passed by reference.
*
* @param $type
* A text string that controls which user hook to invoke. Valid choices are:
* - cancel: Invokes hook_user_cancel().
* - insert: Invokes hook_user_insert().
* - login: Invokes hook_user_login().
* - presave: Invokes hook_user_presave().
* - update: Invokes hook_user_update().
* @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) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment