'Log in' Module (login_box)

This Module allows users to login to Tiki. Based on your selections on the Admin: Login page, there may be additional fields on the module:

If you enable the Users can register option, the module will include a link to the Registration form.
If you enable the Remind passwords option, the module will include a link to the I Forgot My Password form.
If you enable the Remember me option, the module will include a Remember Me checkbox.
If you enable the HTTPS login option, the module will include links to use standard or secure login.
If you enable OpenID authentication, the module will include an OpenID field.

After logging in, the module will change to include a Logout button. If you have permissions, the module will also include a field that allows you to "switch" to another user's login.

Tip: If the Login was removed from the left or right column, you can access the login page directly by using:

../tiki-login.php

Usage

You will see it listed at "Admin > Modules > Assign new module > Module Name (drop down)" (tiki-admin_modules.php).

You can assign this Module to a lateral column (See Module Admin page if needed).

The assigned module (with its default values) looks like this:

Log In

Username

Password

Remember me (for 1 week)

Parameters

Log-in box

Go to the source code

Parameters	Accepted Values	Description
`show_two_factor_auth`		Display two-factor authentication code input.
`groups`		If this parameter is empty, all users are offered in the Switch user drop-down. If this parameter is set to a list of user groups, a user is only offered if it is member of at least one of these. A set of groups is specified with their identifiers (integers) separated by pipe characters ("\|").
`mode`		Display mode: module, header or popup. Leave empty for module mode
`input_size`	int	Number of characters for username and password input fields.
`menu_id`	int	Menu to use as the dropdown in "popup" mode. Defaults to a built in menu with only "My Account" and "Logout"
`forgot`	alpha	Show the "I forgot my password" link (y/n)
`register`	alpha	Show the register link (y/n)
`remember`	alpha	Show the "Remember me" checkbox (y/n)
`show_user_avatar`	alpha	Show the user avatar when in popup mode (y/n)
`show_user_name`	alpha	Show the user name when in popup mode (y/n)
`start_session`	alpha	If the preference "silent_session" is enabled start the session when the login form is shown to avoid CSRF errors. (y/n)

See these pages for information that applies for all modules:

Module — Overall introduction and overview
Module Admin — Introduction to the module admin pages for site-wide and individual module settings
- Assigning Modules — How to select a module to configure it
- Module Settings Interface — Interface for configuring individual module settings
- Module Settings Parameters — Explanation of standard parameter settings for modules
- Creating Custom Modules — How to create user modules
Index of Modules — Links to the documentation of individual modules
User Modules — How (if the feature is active) users can choose and place their modules
Mods Type Modules — Links to modules that are installed as components
Login Config

'Log in' Module (login_box)

Usage

Log In

Parameters

Related Pages