Whitelabel

About Whitelabel

We let our users remove the WPMU DEV branding from all our plugins and replace it with their own branding for their clients. This is done via the Whitelabel tool in the WPMU DEV Dashboard plugin. Find it under Tools -> Whitelabel.

We must adjust some elements in our plugins for those settings to work as expected. Each element to adjust is explained in the tabs at the left.

Here you can find the original instructions on how to implement the whitelabel in your plugin, as well as the instructions for SUI below 2.3.18 which we don't cover in these docs (because you're not using that version anyway, right?).

WPMU DEV Branding

This refers to all the the images that are part of our branding, like the cool super heroes you see around. These images can be hidden by this setting, and a custom image can be set for the dashboard section of each plugin.

Hidding The Branding

Retrieve whether the branding should be hidden by applying the filter wpmudev_branding_hide_branding. It returns a boolean.
If true, hide the branding. If false, display the branding.

<?php
$hide_branding = apply_filters( 'wpmudev_branding_hide_branding', false );
if ( ! $hide_branding) {
echo "DISPLAY WPMUDEV DEFAULT HERO IMAGES";
}
							

You should do this check in every place a super hero or a WPMU DEV branding is shown, except for the footer and documentation elements which have a hook of their own.

Replacing The Hero Image

Retrieve the custom image defined by the user by applying the filter wpmudev_branding_hero_image. It returns a string.
This is an optional field so the value can be empty. This custom image is used within the Summary element.

<?php
$custom_hero_image = apply_filters( 'wpmudev_branding_hero_image', '' );
if ( ! empty( $custom_hero_image ) ) {
echo "CHANGE WPMUDEV DEFAULT HERO IMAGE TO : " . $custom_hero_image;
}
							

Okay, I got the string. Now what?

The image string is not empty and 'hide branding' is true:
1. Use the custom image you just retrieved as the background for the .sui-summary-image-space div. Yes, inline style is fine
2. Add sui-rebranded class to the .sui-summary div

The image string is empty and 'hide branding' is true:
1. Add sui-unbranded class to the .sui-summary div

Rebranded example

1 Active Form
  • Last Submission 5 minutes ago
  • Submissions in the last 30 days 1000

Unbranded example

1 Active Form
  • Last Submission 5 minutes ago
  • Submissions in the last 30 days 1000