White Label for the Shield Security plugin is a part of the Security Admin module. It gives you the ability to rename and re-brand the Shield plugin for your client site installations. With White Label, you can own your own brand.
Important: Before you activate White Label options, please ensure that
White Label Options Explained
There are several White Label options and we're going to explain each one of them, along with examples.
Option: Plugin Name
You can use this option to rename the Shield plugin to your own plugin name. Your plugin name will be displayed to your site users.
If you set your plugin name to i.e. "My Plugin Name", that name will be displayed across the plugin (including emails, badge...).
That means that, wherever you have "Shield" or "Shield Security" name, it will be replaced with "My Plugin Name". See the examples below.
- Plugin Configuration Summary: Original Shield plugin name replaced with your company name.
- Security badge displayed on the site with your plugin name on it
Option: Menu Title
You can use this option to set the main menu title of the plugin (i.e. "My Plugin").
If you set your own menu title of the plugin to "My Plugin", "Shield" name will be replaced with "My Plugin".
- Original menu title of the plugin: Shield Security
- Your own menu title of the plugin: My Plugin
Note: If Menu Title field is left empty, the "Plugin Name" will be used. For example, your plugin name is set to "My Plugin Name", and your main menu title to "My Plugin". If you remove "My Plugin" and leave the field empty, your menu title will display "My Plugin Name".
If you want to get back the original plugin name (Shield Security) in the main menu, remove both plugin name and plugin main titles.
Option: Company Name
You can set your own company name (i.e. "My Company Name").
See the screenshot below.
You can have your own description of the plugin displayed on the plugins page.
See the screenshot below.
Option: Home URL
You can set plugin home page URL (i.e. https://onedollarplugin.com).
When a user clicks the home link for this plugin, this is where they'll be directed.
Important: If you want to set your own company URL on the badge, make sure that the option Replace Badge URL is enabled:
- Original company name, description, home URL
- Your own company name, description, home URL
Option: Menu Icon
You can choose what icon will be displayed in the main menu.
Important: Please ensure that the URLs for your company logos are valid and publicly accessible.
Note: Please provide the full logo URL, i.e. https://your-site.com/wp-content/uploads/2020/02/menu-icon.jpg.
The icon should ideally be square - size 16px x 16px.
- Shield original main menu icon
- Your own main menu icon sample
Option: Dashboard Logo
You can choose what logo will be displayed in the admin pages.
Note: Please provide the full logo URL, i.e. https://your-site.com/wp-content/uploads/2020/02/dashboard-logo.jpg.
Dashboard logo should measure 128px x 128px.
Important: This dashboard logo never changes because non-security admin will never see it.
Option: 2FA Login Logo URL
You can choose what logo will be displayed on the Two-Factor Authentication login page.
Note: Please provide the full logo URL, i.e. https://your-site.com/wp-content/uploads/2020/02/2fa-logo.jpg.
Ideally, this logo would measure 772px x 250px.
- Shield original 2FA login logo
- Your own 2FA login logo
Additional option: Hide Updates
If you want to hide available plugin updates from non-security administrators, simply click the slider to enable this functionality:
More information on White Label for Shield Security can be found in the release article here.
Emails sent to your site users
If you rename Shield plugin name to your plugin name, this name will be displayed to your site users, i.e. 2FA email.
For example, your plugin name is "My Plugin Name":
Note: If you'd like to customise this 2FA email content, you can do that through the use of custom templates.