Shield: White Label options explained

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

  1. White Label system is enabled
  2. Security Admin system is enabled

White Label Options Explained

There are several White Label options and we're going to explain each one of them, along with examples.

Option Example Screenshot
Replace Plugin Badge This option will replace the URL and link on the plugin badge with your Whitelabel settings.

You can set your own plugin name and your site URL (when a user clicks the home link for this plugin, this is where they'll be directed).

Example, if you want to replace the following on the plugin badge
  • plugin name
  • home URL
  • plugin badge (image)
... ensure that "Replace Plugin Badge" option is enabled and that you have set your custom plugin name, URL, dashboard logo (screenshots =>)
Settings

Example badge

Further Plugin Badge Customisation (using filter) You may use a WordPress filter to make fine adjustments to settings and styles of the plugin badge:

https://gist.github.com/paulgoodchild/a5e39497a14cbfe90b76ff1860ec5a16

You can customise
  • plugin name and text
  • badge background 

 Filter (customise plugin name, text & background)

Example (plugin name, text & yellow background)

Plugin Name
The Shield plugin name displayed on the plugin pages will be renamed.

Also, any emails sent out to users will display your custom plugin name in place of “Shield” (i.e. 2FA login verification, user/admin login notification, site reports...).

Hint: You can further customise 2FA login verification email content sent to your users by using custom templates.
More Info

 Examples, your plugin name on the plugin pages

2FA email

Admin login notification email

Site report

Menu Title
This is the main menu title of the Plugin.

Example, if you set your own menu title of the plugin to "My Plugin", "Shield" name will be replaced with "My Plugin". 

Important: If Menu Title field is left empty, the plugin name you have set in the "Plugin Name" field 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". Screenshot =>>

If you want to get back the original plugin name (Shield Security) in the main menu, remove both plugin name and plugin main titles. 
 Example, your plugin menu title

Menu Title field empty



Company Name

You can set your own company name (i.e. "My Company Name").

It will replace our company name with yours, (on the Plugins page).

Description

You can have your own description of the plugin displayed on the Plugins page.


Home URL
You can set plugin home page URL. When a user clicks the home link for this plugin, this is where they'll be directed.

Examples, your company home URL on the Plugins page

On the plugin badge (if you enable "Replace Plugin Badge" option along with adding your own custom home URL)

Menu Icon
You can choose what icon will be displayed in the main menu.

Important: Please provide the full logo URL and ensure that the URLs for your company logos are valid and publicly accessible.

The icon should measure 16px x 16px.

Dashboard Logo
You can choose what logo will be displayed in the i.e. plugin badge.

Important: Please provide the full logo URL and ensure that the URLs for your company logos are valid and publicly accessible.

The icon should measure 128px x 128px.
Example, your logo on the plugin badge

Shield Dashboard logo

2FA Login Logo URL
You can choose what logo will be displayed on the Two-Factor Authentication login page ( OTP).

Important: Please provide the full logo URL.

Ideally, this logo would measure 772px x 250px.


Hide Updates
You can use this option to hide available plugin updates from non-security administrators.                            
Available plugin updates will display to Security Admins only


More information on White Label for Shield Security can be found in the release article here.