Events.Before login

 

The BeforeLogin event is executed on the Login page before verifying the username and password.

Syntax

BeforeLogin($username, $password, $message, $pageObject, $userdata)

 

Note: this event will not be called when 'Remember me' option is enabled and user accesses one of internal pages directly.

Arguments

$username

a user-entered login name.

$password

a user-entered password.

$message

if the function returns false, place the message to be displayed into this variable.

$pageObject

an object representing the current page. For more information, see RunnerPage class.

$userdata

an array with the user-entered data. Access fields by $userdata["FieldName"].

Return value

true: proceed with the login process. Username and password are validated against the Login table.

 

false: abort the login procedure and display the "Invalid login" message.

Applies to pages

Login.

 

Recommended predefined actions and sample events:

•Send a simple email

•Insert a record into another table

•Check to see if a specific record exists

•Display a message on the Web page

•Redirect to another page

See also:

•After successful login

•After unsuccessful login

•Security screen

•CAPTCHA on authentication pages

•Login form appearance

•Sign in with Google