Issue #1198392 by pillarsdotnet: Fixed Add required docs to user_cancel_url() function.

merge-requests/26/head
webchick 2011-06-26 23:01:51 -07:00
parent 6e7f4625b9
commit 67ff15fef1
1 changed files with 12 additions and 1 deletions

View File

@ -2266,7 +2266,18 @@ function user_pass_reset_url($account) {
}
/**
* Generate a URL to confirm an account cancellation request.
* Generates a URL to confirm an account cancellation request.
*
* @param object $account
* The user account object, which must contain at least the following
* properties:
* - uid: The user uid number.
* - pass: The hashed user password string.
* - login: The user login name.
*
* @return
* A unique URL that may be used to confirm the cancellation of the user
* account.
*
* @see user_mail_tokens()
* @see user_cancel_confirm()