#215335 by jvandyk: fix user_login_submit() phpdoc

1 files changed, 4 insertions, 2 deletions

diff --git a/modules/user/user.module b/modules/user/user.module
index 3b0a1632e..9a5b369b2 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -1339,8 +1339,10 @@ function user_authenticate_finalize(&$edit) {
 }
 
 /**
- * A validate handler on the login form. Update user's login timestamp, fire
- * hook_user('login), and generate new session ID.
+ * Submit handler for the login form. Redirects the user to a page.
+ *
+ * The user is redirected to the My Account page. Setting the destination in
+ * the query string (as done by the user login block) overrides the redirect.
  */
 function user_login_submit($form, &$form_state) {
   global $user;