[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Procedural File: users.php

Source Location: /public_html/users.php

Page Details:

This file handles user authentication


author:  Tony Bibbs <>
author:  Mark Limburg <>
author:  Jason Whittenburg


require_once($_CONF['path_system'].'classes/oauthhelper.class.php') [line 910]
require_once($_CONF['path_system'].'classes/openidhelper.class.php') [line 838]
require_once('lib-common.php') [line 46]
Geeklog common function library

require_once($_CONF['path_system'].'lib-user.php') [line 47]

createuser [line 190]

string createuser( string $username, string $email, string $email_conf)

Creates a user Creates a user with the give username and email address


return:  HTML for the form again if error occurs, otherwise nothing.


string   $username   username to create user for
string   $email   email address to assign to user
string   $email_conf   confirmation email address check
[ Top ]

defaultform [line 411]

string defaultform( string $msg)

Account does not exist - show both the login and register forms


return:  HTML for form


string   $msg   message to display if one is needed
[ Top ]

displayLoginErrorAndAbort [line 440]

void displayLoginErrorAndAbort( int $msg, string $message_title, string $message_text)

Display message after a login error


return:  function does not return!


int   $msg   message number for custom handler
string   $message_title   title for the message box
string   $message_text   text of the message box
[ Top ]

emailpassword [line 64]

string emailpassword( string $username, [int $msg = 0])

Emails password to a user This will email the given user their password.


return:  Optionally returns the HTML for the default form if the user info can't be found


string   $username   Username for which to get and email password
int   $msg   Message number of message to show when done
[ Top ]

getpasswordform [line 384]

string getpasswordform( )

Shows the password retrieval form


return:  HTML for form used to retrieve user's password

[ Top ]

loginform [line 298]

string loginform( [boolean $hide_forgotpw_link = false], [int $userstatus = -1])

Shows the user login form after failed attempts to either login or access a page requiring login.


return:  HTML for login form


boolean   $hide_forgotpw_link   whether to hide "forgot password?" link
int   $userstatus   status of the user's account
[ Top ]

newpasswordform [line 156]

string newpasswordform( uid $uid, requestid $requestid)

Display a form where the user can enter a new password.


return:  new password form


uid   $uid   int user id
requestid   $requestid   string request id for password change
[ Top ]

newuserform [line 334]

string newuserform( [int $msg = ''], string $referrer)

Shows the user registration form


return:  HTML for user registration page


int   $msg   message number to show
string   $referrer   page to send user to after registration
[ Top ]

requestpassword [line 102]

string requestpassword( username $username)

User request for a new password - send email with a link and request id


return:  form or meta redirect


username   $username   string name of user who requested the new password
[ Top ]

resend_request [line 490]

void resend_request( )

Re-send a request after successful re-authentication Re-creates a GET or POST request based on data passed along in a form. Used in case of an expired security token so that the user doesn't lose changes.

[ Top ]

stripslashes_gpc_recursive [line 473]

mixed stripslashes_gpc_recursive( &$value, ref $value)

Helper function: When magic_quotes_gpc = On, everything in $_GET and $_POST has already been auto-escaped. So we need to undo this before re-creating the GET or POST request.

NOTE: Assumes that is only being called when magic_quotes_gpc = On


return:  un-escaped value or array of values
see:  COM_stripslashes()


ref   $value   value to un-escape
[ Top ]

Documentation generated on Sun, 02 Oct 2016 07:56:42 +0000 by phpDocumentor 1.4.3