Actions

Customising the Login Form module

From Joomla! Documentation

Revision as of 15:09, 2 November 2008 by Dextercowley (Talk | contribs)

Contents

What does the Login Form module do?

Login module example.png

The Login Form module presents site visitors with a form with username and password fields. If the user enters a valid username/password combination they will be granted access to additional resources on your website. Which additional resources they will have access to can be configured separately. See restricting user access to resources for more information.

Once logged in, the Login Form module presents the user with a Logout button. Logged in users who are inactive for a predetermined period of time will be automatically logged out.

To be visible to site visitors the Login Form module must be enabled and assigned to one or more web pages on your Joomla! site.

The Login Form module will appear in whatever module position it is assigned to in the current template. It is also possible to have a Login Form that will appear in place of regular content when a Menu Item is clicked. To learn how to do this see Creating a Login Form menu item.

To change the Login Form module settings

To change settings which control the information shown in the Login Form module and some aspects of its behaviour, do this:

  1. Log in to the Administrator back-end. To learn how to do this read: Logging in or out of the Administrator back-end.
  2. Click the Extensions > Module Manager menu item.
  3. From the list of Modules find the one called "Login Form". There may be several pages of Modules listed so you might need to look on subsequent pages. You can make the search easier by clicking the drop-down list containing Select Type and clicking the "mod_login" item (they are listed in alphabetical order).
  4. Click the Module Name, ie. Login Form.
  5. You will see the "Module: [Edit]" screen which contains three groups of fields: Details, Menu Assignment and Parameters.
  6. Make the changes you need to make.
  7. Click the Save or Apply toolbar button to implement the new settings:
    • The Save toolbar button will save your changes and return you to the Module list screen.
    • The Apply button will save your changes but leave you in the Module Edit screen.
  8. You should see a blue message: "Item saved." which confirms that your changes have been saved.


To enable the Login Form module

Login Module in Module Manager

If you want certain (authorised) visitors to your website to be able to log in and view additional resources, then you must enable the Login Form module. To enable the Login Form module either:

  1. change the Enabled status to Yes (green symbol) on the Module Manager screen; or
  2. click the Login Form module name in Moduel Manager screen to display module's details, change Enabled radio button to Yes and Save changes.

To learn more see Changing the Login Form module settings;

To assign the Login Form module to selected web pages

You can make the Login Form module appear on one or more pages by assigning it to selected Menu Items. This is done using the fields in the Menu Assignment group on the Module Edit screen. To learn how to do this see Changing the Login Form module settings. The following list describes the settings in the Menu Assignment group.

  • Menus: Is a radio button field with the following options:
    • All: The Login Form module will appear on all screens.
    • None: The Login Form module will not appear on any screens.
    • Select Menu Item(s) from the List: The Login Form module will appear on those screens selected in the Menu Selection field.
  • Menu Selection: Shows a list of all the Menus and Menu Items from which one or more may be selected. This field is only used if the Menus field is set to Select Menu Item(s) from the List. To select more than one Menu Item on the list, you Shift-click to select a range of items, or Control-click to select or deselect individual items.

To customise the information shown in the Login Form module

The information shown in the Login Form module can be customised from the Module Edit screen. To learn how to do this see Changing the Login Form module settings. The following list describes the various settings that will change the appearance of the Login Form module.

  • Title: Changes the title shown for the Login Form module if Show Title is set to Yes. The default is "Login Form".
  • Show Title:
    • If Yes then the Title will be shown at the top of the Login Form. This is the default.
    • If No then the Title will not be shown at the top of the Login Form.
  • Pre-text: This text will be shown above the Login Form but below the Title. It may contain HTML markup.
  • Post-text: This text will be shown below the Login Form. It may contain HTML markup.
  • Greeting:
    • If Yes then a simple greeting message is shown above the Logout button once the user is logged in. For example, it might say "Hi, Joe Bloggs". This is the default.
    • If No then no greeting message is shown above the Logout button.
  • Name/Username: Determines whether the user's real name or the user's username is shown as part of the simple greeting message.

Additionally, the "Create an account" link will only be shown if the Allow User Registration field in Global Configuration is set to Yes. To learn how to change this setting see Changing user registration settings.