Shortcode

Description

Displays the output of the plugin.

Usage

[theme-my-login instance="1"]

Parameters

instance
(string) A unqiue instance ID for this instance.
default_action
(string) The action to display. Defaults to “login”.
login_template
(string) The template used for the login form. Defaults to “login-form.php”.
register_template
(string) The template used for the register form. Defaults to “register-form.php”.
lostpassword_template
(string) The template used for the lost password form. Defaults to “lostpassword-form.php”.
resetpass_template
(string) The template used for the reset password form. Defaults to “resetpass-form.php”.
user_template
(string) The templated used for when a user is logged in. Defalts to “user-panel.php”.
show_title
(boolean) True to display the current title, false to hide. Defaults to true.
show_log_link
(boolean) True to display the login link, false to hide. Defaults to true.
show_reg_link
(boolean) True to display the register link, false to hide. Defaults to true.
show_pass_link
(boolean) True to display the lost password link, false to hide. Defaults to true.
register_widget
(boolean) True to allow registration in widget, false to send to register page. Defaults to false.
lostpassword_widget
(boolean) True to allow password recovery in widget, false to send to lost password page. Defaults to false.
logged_in_widget
(boolean) True to display the widget when logged in, false to hide. Defaults to true.
show_gravatar
(boolean) True to display the user’s gravatar, false to hide. Defaults to true.
gravatar_size
(integer) The size of the user’s gravatar. Defaults to “50”.
before_widget
(string) Content to display before widget. Defaults to “<li>”.
after_widget
(string) Content to display after widget. Defaults to “</li>”.
before_title
(string) Content to display before the title (if displayed). Defaults to “<h2>”.
after_title
(string) Content to display after the title (if displayed). Defaults to “</h2>”.

Widget

In addition to the “built-in” login page, Theme My Login comes with a widget as well. It is used just like any other WordPress widget.

Widget Settings

Default Action
The default action for this widget. Defaults to “login”.
Show When Logged In
Uncheck this option to hide the user panel when a user is logged in. Defaults to true.
Show Title
Uncheck this option to hide the widget title. Defaults to true.
Show Login Link
Uncheck this option to hide the login link from being displayed under the form. Defaults to true.
Show Register Link
Uncheck this option to hide the register link from being displayed under the form. Defaults to true.
Show Lost Password Link
Uncheck this option to hide the lost password link from being displayed under the form. Defaults to true.
Show Gravatar
Uncheck this option to hide the gravatar from the logged in user panel.
Gravatar Size
Sets the size of the logged in user gravatar (in pixels).
Allow Registration
Uncheck this option to disable registration in the widget. Clicking the register link will then forward to the register page. Defaults to false.
Allow Password Recovery
Uncheck this option to disable password recovery in the widget. Clicking the lost password link will then forward to the lost password page. Defaults to false.

User Moderation

The User Moderation module allows you to moderate users upon registration. If you do not see the “Moderation” tab when viewing the Theme My Login settings page, click on the “General” tab, followed by the “Modules” sub-tab. Then check “Enable User Moderation” and click “Save Changes”.

Upon activation of this module, a new user role will be created, titled “Pending”. This role has no privileges by default. When a user confirms their e-mail address or when you approve a user, they are automatically assigned to the default user role for the blog/site.

Moderation Settings

None
Check this option to require no moderation.
E-mail Confirmation
Check this option to require new users to confirm their e-mail address before they may log in. If using Custom E-mail module, “User Activation” will be added to the list of customizable e-mail messages.
Admin Approval
Check this option to require new users to be approved by an administrator before they may log in. If using Custom E-mail module, “User Approval” and “User Denial” will be added to the list of customizable e-mail messages.

Approving A User

To approve a user, the user must first be in the “Pending” role. Also, “Admin Approval” must be set as the moderation type. Visit the “Users” section of the WordPress administration area. Hover over a particular pending user’s row and you will see a link titled “Approve”. Simply click this link to approve this user.

Denying A User

To deny a user, the user must first be in the “Pending” role. Also, “Admin Approval” must be set as the moderation type. Visit the “Users” section of the WordPress administration area. Hover over a particular pending user’s row and you will see a link titled “Delete”. Simply click this link to delete/deny this user.

Themed Profiles

The Themed Profiles module allows your users to edit their profile via the “front-end” of your site. The profile will use the login page with an action of “profile”. In order to use this module, simply enable it. Enable the module by visiting the Theme My Login settings page and clicking on the “General” tab, followed by the “Modules” sub-tab. Then check “Enable Themed Profiles” and click “Save Changes”. No further configuration is needed.

Security

The Security module allows you to enable certain features that will help to protect your site. If you do not see the “Security” tab while viewing the Theme My Login settings page, click on the “General” tab, followed by the “Modules” sub-tab. Then check “Enable Security” and click “Save Changes”.

Log In Attempts

As of Theme My Login 6, the only feature of the security module is brute force attack protection. This works by allowing you to specify a specific number of log in attempts for a user before the account is locked. When an account is locked, the user can not log in to the site. The account can be locked for a specified duration or indefinitely. You can manually unlock an account by visiting the “Users” section of the WordPress admin area. You can also manually lock a user here.

Custom User Links

The Custom User Links module allows you to specify links that will be displayed in the Theme My Login user panel when a user is logged in. Custom links can be assigned per user role. Each user role is listed as a sub-tab when viewing the “User Links” tab of the Theme My Login settings page. If you do not see the “User Links” tab while viewing the Theme My Login settings page, click on the “General” tab, followed by the “Modules” sub-tab. Then check “Enable Custom User Links” and click “Save Changes”.

The following settings apply to each user role. For the sake of less redundancy, they will only be listed once. By default, there are already links for “Dashboard” and “Profile” per each user role once the module is activated.

Adding Links

New links can be added by using the form labeled “Add New Link”. Simply enter a title for the link in the “Title” field and the URL in the “URL” field. Once you’re done, click the “Add Link” button next to the fields. Alternatively, you can click the primary “Save Changes” button if you wish.

Editing Links

You will see existing links in a table with “Title” on the left and “URL” on the right. From this table, links can be re-arranged, edited and deleted. To edit a link, simply change the fields as you wish and then click the corresponding “Update” button. Alternatively, you can click the primary “Save Changes” button if you wish to edit multiple rows at once.

Deleting Links

To delete a link, simply click the corresponding “Delete” button in the same row as the link you want to delete.

Reordering Links

To reorder the links, simply drag and drop the rows as you see fit. Click the “Save Changes” button when you are done.

Custom Redirection

The Custom Redirection module allows you to specify where your users are redirected upon successful log in/log out. Redirection can be assigned per user role. Each user role is listed as a sub-tab when viewing the Redirection tab of the Theme My Login settings page. If you do not see the Redirection tab while viewing the Theme My Login settings page, see Managing Modules to enable the module.

The following settings apply to each user role. For the sake of less redundancy, they will only be listed once.

Log In

Default
Check this option to send the user to their WordPress Dashboard/Profile.
Referer
Check this option to send the user back to the page they were visiting before logging in.
[Custom]
Check this option to send the user to a custom location, specified by the text field.

Log Out

Default
Check this option to send the user to the log in page, displaying a message that they have successfully logged out.
Referer
Check this option to send the user back to the page they were visiting before logging out. Note: If the previous page being visited was an admin page, this can have unexpected results.
[Custom]
Check this option to send the user to a custom location, specified by the text field.

Custom Passwords

The Custom Passwords module allows you to allow your users to set their own password upon registration and password reset. In order to use this module, simply enable it. Enable the module by visiting the Theme My Login settings page and clicking on the General tab, followed by the Modules sub-tab. Then check Enable Custom Passwords and click Save Changes. No further configuration is needed.

Custom E-mail

The Custom E-mail module provides a simple interface for you to customize all login/registration system e-mail messages. Any field left blank within the settings for this module will utilize the WordPress default settings. The different system e-mail messages are broken down into sub-tabs visible when viewing the E-mail tab of the Theme My Login settings page. If you do not see the E-mail tab while viewing the Theme My Login settings page, see Managing Modules to enable the module.

General Fields

All of the customizable e-mail messages will use most of the following fields. For the sake of less redundancy, all of them will be centrally listed here.

To
Some admin e-mail messages allow you to specify where they should be sent. You may enter a single e-mail address or multiple e-mail addresses by separating them with a comma. Defaults to the E-mail address setting within the WordPress Settings General screen
From Name
All e-mail messages allow you to specify a name in which to send from. This will appear as the from name in the user’s inbox. Defaults to “WordPress”.
From E-mail
All e-mail messages allow you to specify an e-mail address in which to send from. This will appear as the from e-mail address in the user’s inbox. Defaults to “wordpress@yoursite.com”.
E-mail Format
All e-mail messages allow you to specify a format in which to send. This can be either “Plain Text” or “HTML”. Select “HTML” only if you will use markup within the message. Defaults to “Plain Text”.
Subject
All e-mail messages allow you to customize the message subject. You may utilize any of the available variables here.
Message
All e-mail messages allow you to customize the message body. You may utilize any of the available variables here.
Disable Admin Notification
Some admin e-mail messages are able to be disabled. Simply check this box to disable sending of these particular e-mail messages.

Available Variables

All of the customizable e-mail messages allow usage of variables within the subject and message body. For the sake of less redundancy, all of them will be centrally listed here. This is not a complete list. You can also access any available variable from the get_userdata() function (if it’s a user-related message) and the bloginfo() function using the %variable% syntax.

%blogname%
The title of your blog/site.
%siteurl%
The URL of your site.
%loginurl%
The login URL of your site.
%reseturl%
The user-specific password reset URL.
%user_login%
The user login of the user who triggered the message.
%user_email%
The e-mail address of the user who triggered the message.
%user_pass%
The password of the user who triggered the message.
%user_ip%
The IP address of the user who triggered the message.

New User

User Notification
This e-mail message will be sent to a new user upon registration. Please be sure to include the variable %user_pass% if using default passwords or else the user will not know their password!
Admin Notification
This e-mail message will be sent to the e-mail address or addresses specified in the To field, upon new user registration.

Retrieve Password

This e-mail message will be sent to a user when they attempt to recover their password. Please be sure to include the variable %reseturl% or else the user will not be able to recover their password!
Reset Password

User Notification
This e-mail will be sent to a user upon successful password recovery. Please be sure to include the variable %user_pass% if using default passwords or else the user will not know their password!
Admin Notification
This e-mail will be sent to the e-mail address or addresses specified in the To field, upon user password change.

General

The Theme My Login Settings can be accessed via the WordPress Administration Panel. It can be found as a submenu item under the Settings menu.

Basic

Page ID
This should be the ID of the WordPress page to be used as the main login page. It is imperative that this page contain the [theme-my-login] shortcode. It is also as equally important that this field point to the correct page ID. An incorrect value here will wreak havoc across your whole login/registration system and is the number one cause of malfunctions with the plugin.
Pagelist
If Show In Pagelist is checked, a dynamic login link will appear in any menu generated with functions like wp_list_pages(), wp_page_menu() and wp_nav_menu(). This link will display “Log In” when a user is not logged in and “Log Out” when a user is logged in. This link is also translated if a different language is being utilized. To completely hide this link from these functions, simply uncheck this option.
Stylesheet
If Enable “theme-my-login.css” is checked, theme-my-login.css will be loaded within every page of your site. By default, the stylesheet contains the bare-minimum needed to make the login form look presentable. However, your specific theme may or may not change the intended appearance drastically. If you would like to make changes to the stylesheet, copy it to your current theme’s directory. If theme-my-login.css exists in your theme’s directory, the plugin will load this version instead of the default. This is particularly useful during upgrades to the plugin, where any changes made to the stylesheet within the plugin directory will be lost. If you do not wish to load the stylesheet, simply uncheck this option.

Modules

As of version 6, Theme My Login now utilizes “modules” to extend the functionality of the base plugin. Theme My Login modules are similar to WordPress plugins, in the sense that they allow you to extend the basic functionality of the plugin as needed, without otherwise “bloating” the code. Theme My Login comes bundled with many useful modules by default. These modules are as follows:

Managing Modules

In order to enable or disable a module, visit the Theme My Login settings page, click on the General tab, followed by the Modules sub-tab. Then check or uncheck Enable [Module Name] and click Save Changes.