Shut down your site for a little while and do some maintenance on it!
GPL-2.0 License
Shut down your site for a little while and do some maintenance on it!
/plugins
directory of an application's GitHub repository.VIP_MAINTENANCE_MODE
constant as true in vip-config/vip-config.php
.To add a custom template and messaging:
template-maintenance-mode.php
.wp_head()
and wp_footer()
calls.Using filters and conditionals, you can customize the behavior of the Maintenance Mode plugin based on your needs. These options rely on the plugin being installed as described above.
Selectively Load Maintenance Mode
Configure Maintenance Mode to only display for a specific network site. Code similar to this example must be added to the vip-config/vip-config.php
file:
$site_name = $_SERVER['SERVER_NAME'];
$lockdown = false;
if ( false !== strpos( $site_name, 'url-to-enable-maintentance-mode' ) ) {
// Set lockdown
$lockdown = true;
}
// Set maintenance plugin
define( 'VIP_MAINTENANCE_MODE', $lockdown );
Enable WordPress REST API
Configure Maintenance Mode to keep the WordPress REST API enabled even though the rest of the site is not accessible. Note that this code should be added to a file located within the client-mu-plugins
directory:
// Generally allow API access
add_filter( 'vip_maintenance_mode_restrict_rest_api', '__return_false' );
You can also choose to enable the REST API only in more narrow use-cases:
add_filter( 'vip_maintenance_mode_restrict_rest_api', 'x_mm_allow_api' );
function x_mm_allow_api( $default ) {
if (my_check() ) {
return false;
}
return true;
}
On Twenty Twenty-One:
On Twenty Twenty:
On Twenty Nineteen:
On Twenty Seventeen: