White Labelling
Are you looking for a way to make our VIK plugins white label? Well, you are in the right place!
You can download our White Label - Installer plugin from HERE.
How does it work?
The installation of the plugin can be completed by uploading the downloaded package from the Plugins > Add New Plugin > Upload Plugin section. During the activation, the plugin will perform all the following tasks:
- registers the permissions of the user that currently installed the plugin;
- creates the must-use plugins directory, if not yet available;
- copies the White Label plugin within the right directory;
- the installer deletes itself from the plugins list;
- completes a redirection to the page where you can find the installed White Label plugin.
What is a must-use plugin?
Must-use plugins are plugins installed in a special directory inside the content folder and which are automatically enabled on all sites in the installation. Must-use plugins do not show in the default list of plugins on the Plugins page of wp-admin (although they do appear in a special Must-Use section) and cannot be disabled except by removing the plugin file from the must-use directory, which is found in wp-content/mu-plugins by default.
Since the white label is installed as a must-use plugin, your customers won't be able to easily identify it or deactivate it.
What is the plugin capable of?
Here is explained what are all the capabilities of the plugin.
- Replaces the plugin manufacturer information (E4J s.r.l. or VikWP) with your own (ACME by default).
- Replaces the plugin manufacturer URL (https://vikwp.com) with your own (https://acme.com by default).
- Replaces any occurrences of the VikAppointments and Vik Appointments words with your own (Appointments by default).
- Replaces any occurrences of the VikBooking and Vik Booking words with your own (Bookings by default).
- Replaces any occurrences of the VikRentCar and Vik Rent Car words with your own (Rent a Car by default).
- Replaces any occurrences of the VikRentItems and Vik Rent Items words with your own (Rent Items by default).
- Replaces any occurrences of the VikRestaurants and Vik Restaurants words with your own (Restaurant by default).
- Hides the Help button from the top-right side of the page, which contains information taken from our documentation.
- Hides the PRO Version button displayed on the right side of the main menu.
- Hides the plugin information footer as well as the setting used to toggle its visibility.
- Disables all the RSS features as well as the widget displayed in the WordPress dashboard.
- Disables the possibility to leave a feedback during the deactivation of the VIK plugin.
- Hides all the information about new available versions for all our VIK plugins.
- Prevents all the VIK plugins from using the auto-update feature of WordPress.
You will be able to change the texts only for the plugins actually installed on your website.
The only thing that cannot be masked, because of the operational logic, is the "vik..." word that you might see within the URLs in the back-end, such admin.php?page=vikbooking
.
Where do I specify my own texts?
You can change the default placeholders with your own by accessing the settings page of the White Label plugin:
- open the Plugins > Installed Plugins page from the back-end of your WordPress;
- click the Must-Use link from the status filters placed above the plugins list;
- click the Settings link displayed below the White Label name.
The Settings link appears only to the user that installed the White Label plugin. Therefore a best practice might be to have 2 different administrator accounts, one for the web master (you) and the other one for the admin (your customer). This way, the real administrator of the website won't be able to edit the settings of this plugin, since the latter was installed by the web master.
IMPORTANT TIP: if you need to update a VIK plugin to a newer version, you should temporarily tick the Enable Updates parameter from the settings of the White Label plugin. At this point you should be able to see the available update from the plugins list. After completing the update, you can head back to the settings of the White Label plugin and turn off the previously enabled setting.
Troubleshooting
During the installation/activation of the plugin, you might face one of the following error messages.
Make sure to have at least the 6.5 version of WordPress installed, because prior versions might have problems with the installation of packages manually compressed with a Mac OS.
The plugin itself is unable to create the mentioned folder. You should access the root of your WordPress via FTP and proceed with the creation of the mentioned folder.
After creating the plugin, you can head back to the page where you got the error message and refresh it.
The installer is unable to copy the White Label plugin within the mentioned folder because of a permissions error. You can reach that folder via FTP to make sure its permissions have been properly configured as 644. You can even try to delete the folder and manually recreate it.
After creating the plugin, you can head back to the page where you got the error message and refresh it.
The installer is unable to copy the White Label plugin for an unknown reason. You need to reach the root of your WordPress website via FTP and manually copy the file below into the directory mentioned in the error message:
/wp-content/plugins/whitelabel-installer/must-use/whitelabel.php
After creating the plugin, you can head back to the page where you got the error message and refresh it.