Issue #1192178 by pillarsdotnet: Changed The user_module_invoke() function lacks documentation of parameters.
parent
0f9c1354d1
commit
41efebcf07
|
@ -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
|
* We cannot use module_invoke() for this, because the arguments need to
|
||||||
* be passed by reference.
|
* 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) {
|
function user_module_invoke($type, &$edit, $account, $category = NULL) {
|
||||||
foreach (module_implements('user_' . $type) as $module) {
|
foreach (module_implements('user_' . $type) as $module) {
|
||||||
|
|
Loading…
Reference in New Issue