Help: Login Box Macro Template Variables
For more help, visit the WebGUI Community Wiki.
- user.isVisitor
- True if the user is a visitor.
- customText
- The text supplied to the macro to display if the user is logged in. In general, this is used instead of the logout.label and logout.url variables.
- hello.label
- Internationalized welcome message.
- customText
- The text supplied to the macro to display if the user is logged in. In general, this is used instead of the logout.label and logout.url variables.
- account.display.url
- URL to display the account.
- logout.label
- Internationalized logout message.
- form.header
- Form header.
- username.label
- Internationalized label for "username".
- username.form
- Form element for the username.
- password.label
- Internationalized label for "password".
- password.form
- Form element for the password.
- form.login
- Action to perform when logging in.
- account.create.url
- URL to create an account.
- account.create.label
- Internationalized label for "create an account"
- helpvar form.returnUrl
- When this hidden form element is present, the user will be returned to the current page after they login
- form.footer
- Form footer.
- webgui.version
- The version of WebGUI on your site.
- webgui.status
- The release status for this version of WebGUI (stable, beta, gamma, etc.)
- session.user.username
- The current user's username.
- session.user.firstDayOfWeek
- From the current user's profile, the day they selected to be the first day of the week.
- session.config.extrasurl
- From the WebGUI config, the URL for the extras directory.
- session.var.adminOn
- This variable will be true if the user is in Admin mode.
- session.setting.companyName
- From the WebGUI settings, the company name.
- session.setting.anonymousRegistration
- From the WebGUI settings, whether or not anonymous registration has been enabled.
- session form variables
- Session Form Variables
Any form variables will be available in the template with this syntax:
<tmpl_var session.form.variable>
If there is more than 1 value in a form variable, only the last will be returned. - session scratch variables
- Session Scratch Variables
Any scratch variables will be available in the template with this syntax:
<tmpl_var session.scratch.variable>
Admin Console
