Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 3.83 KB

readme.md

File metadata and controls

52 lines (32 loc) · 3.83 KB
Raw

TukuToi Maintenance ClassicPress Plugin: Required CP Version WordPress Plugin: Tested WP Version

Bugs Vulnerabilities Maintainability Rating Reliability Rating Security Rating

Enable and Control a Custom Maintenance Mode for your WordPress Website.

TukuToi Maintenance allows you to setup and control a Custom "Under Maintenance" or "Coming Soon" Screen for your WordPress Website.

The Plugin is lightweight and has a Settings Screen allowing you to control all aspects of the Maintenance Screen from the WordPress backend.

You will be able to control the image (or color) of the Maintenance Screen, add a CountDown and a Custom Heading, as well as a Custom message to the screen. You can control the request status (defaults to 401 temporarily unavailable) and the time for when the site will be back. This is useful to tell Crawling bots when to start re-crawling your website.

Installation

  1. Upload the Plugin files to the /wp-content/plugins/ directory.
  2. Activate the plugin through the 'Plugins' menu in WordPress.
  3. Setup and control the Settings in the native WordPress Settings > Reading screen, under the newly added TukuToi Maintenance Section

Frequently Asked Questions

How big should the Image used for the Maintenance Screen be?

The optimal (website) background image size is 1920 x 1080 pixels with a 16:9 ratio, the dpi (dots per inch) should be at least 72. However you are free to upload bigger or smaller sizes, as you wish.

How big should the Logo Image used for the Maintenance Screen be?

It should ideally be at least 300px square.

Can I still access the WP Admin when activating the Maintenance Mode?

Of course! You will have to navigate to the native /wp-login.php URL of your website and will be able to login. For Administrators, the Front End will not show the Maintenance Mode. It will continue to show your website, in order to allow you to control your development.

Can I Fully Customize the Maintenance Mode Template?

Of course! You can either use the Plugin settings to customize the template, or, you can also load your 100% custom PHP template, if you wish. To do so, just pass your Custom PHP template to the tkt_mtn_template_path filter which the plugin provides.

Example (assuming you store the template in your Theme's template-parts/post/ folder):

add_filter( 'tkt_mtn_template_path', 'load_my_own_template', 10, 1 );
function load_my_own_template( $template_path ){

	$template_path = get_template_directory() .'/template-parts/post/custm_template.php';//Load your own template.

	return $template_path;

}

You can take a look at the Plugin's Template in tkt-maintenance/public/partials/tkt-maintenance-public-display.php file to get a kickstart for your own Template.