login()

Overview

public boolean function login(
      required string  loginId             
    ,          string  password             = ""
    ,          boolean rememberLogin        = false
    ,          numeric rememberExpiryInDays = 9
    ,          boolean skipPasswordCheck    = false
    ,          boolean recordLogin          = true
)

Attempts CMS admin login with login ID and password. Returns true on success, false otherwise. See CMS permissioning for a full guide to CMS admin users.

Arguments

Name	Type	Required	Description
loginId	string	Yes	User provided login ID / email address
password	string	No (default="")	User provided password
rememberLogin	boolean	No (default=false)
rememberExpiryInDays	numeric	No (default=9)
skipPasswordCheck	boolean	No (default=false)
recordLogin	boolean	No (default=true)