LWSDOCUMENTATION

The User Plugin

Welcome to the Long Watch Studio Document Centre dedicated to 'The User Plugin'. This plugin helps you manage your users authentification and redirection.

This documentation is divided in several sections :

  1. Login and Subscription
  2. Redirections

 

LOGIN AND SUBSCRIPTION

The User Plugin allows your users to log in and register without having to use the Admin Area of your WordPress site. It also allows you to manage redirections once the users have been authenticated according to their roles or login credentials.

Here we will go over the various features of this plugin. To access the settings panel, go to Settings->The User Plugin in your WordPress Administration.

General Settings

Translations

In the General Settings section, you can enter the translations of the texts that will be presented to your users in the login/registration forms. The texts on the left are the texts displayed by default. If these texts suit you, you do not have to re-enter them on the righthand side. Should you require a specific translation or different terms, you can complete the text entry fields on the right and then click Save changes at the bottom of the page.

Lost Password

This administrative section allows you to specify the pages used during the password retrieval procedure. By default, The User Plugin creates 2 dedicated pages on your WordPress Website. However, if you want to create your own pages, we provide 2 shortcodes that you can use in WordPress pages:

  • [send_password_form] which offers users a form in which they can enter their email address. Upon validation of this form, a new password is generated and emailed to the user.
  • [change_password_form] which offers users a form in which they can change their password. Validating this form allows a previously-authenticated user to change password.

You can specify the content of the email sent to your users when they request a new password. Shortcodes you can use are displayed on the Admin Panel.

 

Page Login

FEATURES

  • Allow users to register: if this box is checked, users will see 2 tabs in the form. The first will allow them to log in and the second will allow them to create an account on the site.
  • Activate “Remember me”: if this box is checked, the users will see a “Remember me” checkbox in the login form. If they check the box, they will automatically be logged in each time they visit your site.
  • Activate “Password lost”: if this box is checked, a “Lost your password?” link will be visible in the login form. Users will be redirected to the page that you have specified in the “General settings” section in order to fill in their email address. Once the form has been validated, the previously configured procedure will apply.

REGISTRATION

This administrative section is used to configure the user registration function:

  • Notify administrator about registrations: notifies the site administrator(s) when a new user registers.
  • Activation of the user account: parameters enabling you to oblige users to activate their account before authorising them to log in:
    • User activation required: checking the box obliges users to activate their account.
    • Page after registration: future users are redirected to this page after their registration and before activation. One page by default is supplied with the plugin.
    • Account activation page: user activation page. This is the destination page of the activation link that users receive by email. It contains a welcome message confirming that the activation has been successful. One page by default is supplied with the plugin.
    • Account activation error page: destination page for failed or fraudulent account activation attempts. One page by default is supplied with the plugin.
    • Email activation text: in the text entry field, you can enter the text that you wish to see appear for future users when activating your account.

CUSTOMISATION

In this section, you can customise the display of the login/registration form with your logo and personalised messages:

  • Form logo: select your logo or other image from your media library. The recommended size is 400 pixels wide/200 pixels high. The logo is centred automatically in the form.
  • Login form text: customised text that users see above the text entry fields.
  • Registration form text: customised text that users see above the text entry fields.
  • Logout text: customised text that users see above the logout button.

Style

In this part, you can customize the display of the login/register form. In the style generator, select the elements you wish to change and modify them to match your needs.

CSS

If you have CSS Coding knowledge, you can go even further in the form styling. The classes names are shown in the style generator to help you.

Widget Login

FEATURES

Here are the various features available in the form that can be incorporated in your WordPress widgets:

  • Activate “Remember me”: if this box is checked, the users will see a “Remember me” checkbox in the login form. If they check the box, they will automatically be logged in each time they visit your site.
  • Activate “Password lost”: if this box is checked, a “Lost your password?” link will be visible in the login form. The procedure will differ depending on your version of the plugin:
    • Standard: users following this link will be redirected to the WordPress Admin Area to follow the standard password retrieval procedure.
    • Pro Version: users will be redirected to the page that you have specified in the “General settings” section in order to fill in their email address. Once the form has been validated, the previously configured procedure will apply.

CUSTOMISATION

In this section, you can customise the display of the login form using personalised messages:

  • Login form text: customised text that users see above the text entry fields.
  • Logout text: customised text that users see above the logout button.

Style

In this part, you can customize the display of the login form. In the style generator, select the elements you wish to change and modify them to match your needs.

CSS

If you have CSS Coding knowledge, you can go even further in the form styling. The classes names are shown in the style generator to help you.

Menu Login

FEATURES

Here are the various features available in the form that can be incorporated in your WordPress menus:

  • Activate “Remember me”: if this box is checked, the users will see a “Remember me” checkbox in the login form. If they check the box, they will automatically be logged in each time they visit your site.
  • Activate “Link to login page”: if this box is checked, a link to the login page is added to [location].

CUSTOMISATION

In this section, you can customise the display of the login form using personalised messages:

  • Login form text: customised text that users see above the text entry fields.
  • Logout text: customised text that users see above the logout button.

Style

In this part, you can customize the display of the login form. In the style generator, select the elements you wish to change and modify them to match your needs.

CSS

If you have CSS Coding knowledge, you can go even further in the form styling. The classes names are shown in the style generator to help you.

Redirections

If users are recognized when they come from another website, they can be redirected or not, depending on your needs. Check the "Enabled" box to allow the redirections.

If you enabled the redirections, you can specify one or several URLs for which redirections won't happen. Use the semicolon (;) between several URLs. Your WordPress Website will never trigger the redirection (except for login/logout actions), you don't need to add it.

Redirections List

The Redirections tab allows you to specify the destination pages of your visitors following successful login or when they log out. There are numerous possibilities to enable you to obtain, for each user or group of users, the desired redirection.

1 – FiltERs

The Filters, found above the Redirections list, allow you to display a sub-selection of redirections making it easier to find what you are looking for.

2 – BROWSE

Should you have entered a large number of redirections, the Browse function enables you to navigate the various pages of the Redirections list.

3 – ONLINE POSSIBILITIES

When you place your mouse on a line in the list of redirections, you have several possibilities:

  • Add to trash: allows you to delete the redirection.
  • Copy: copies the line to a new line.
  • Modify: opens the data entry form on this line.

4 – DATA ENTRY FORM

Le formulaire de saisie vous permet de saisir ou de modifier une redirection. Plusieurs possibilités vous sont proposées dans ce formulaire :

  • Redir. type: type of redirection, by default, by role or by user. The rest of the form is modified instantly according to your choice.
  • Trigger Action: event triggering the redirection, login or logout.
  • Role / User: depending on your choice of type, enables you to select a role or to enter a user. When entering a user, simply type a few characters and let the search engine find the corresponding users.
  • Target or Url: the Target zone allows you to select a destination page from the list of your WordPress pages. The URL zone allows you to directly enter a redirection URL, whether to within your site or to an external site.

5 – NEW redirection

This button allows you to create a new redirection. When you click the button, a new line is created in the list of redirections and the data entry form opens for you to specify the conditions of the redirection.

Be careful! Your list of redirections must always propose default redirections for the login and logout actions.