https://github.com/automattic/maintenance-mode-wp

Shut down your site for a little while and do some maintenance on it!
https://github.com/automattic/maintenance-mode-wp

maintenance-mode wordpress wordpress-plugin wpvip-plugin

Last synced: 3 months ago
JSON representation

Shut down your site for a little while and do some maintenance on it!

• Host: GitHub
• URL: https://github.com/automattic/maintenance-mode-wp
• Owner: Automattic
• License: gpl-2.0
• Created: 2017-02-16T21:17:46.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T16:20:29.000Z (5 months ago)
• Last Synced: 2024-10-07T11:16:54.930Z (3 months ago)
• Topics: maintenance-mode, wordpress, wordpress-plugin, wpvip-plugin
• Language: PHP
• Homepage:
• Size: 217 KB
• Stars: 39
• Watchers: 6
• Forks: 13
• Open Issues: 11
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Maintenance Mode

Shut down your site for a little while and do some maintenance on it!

## Installation and activation

1. Add the plugin to the `/plugins` directory of an application's GitHub repository.

2. Define the `VIP_MAINTENANCE_MODE` constant as true in `vip-config/vip-config.php`.

3. Activate the plugin in the WordPress Admin dashboard Plugins screen.

### Custom Template

To add a custom template and messaging:

 - Create a template in your theme's root folder named `template-maintenance-mode.php`.

 - This should be a simple HTML page that includes the message you want to show your visitors.

 - Note: the template should include `wp_head()` and `wp_footer()` calls.

### Additional Configurations

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;

    }

## Default template screenshots

On Twenty Twenty-One:  

![Screenshot of active Maintenance mode on Twenty Twenty-One](screenshot-twentytwentyone.png)

On Twenty Twenty:  

![Screenshot of active Maintenance mode on Twenty Twenty](screenshot-twentytwenty.png)

On Twenty Nineteen:  

![Screenshot of active Maintenance mode on Twenty Nineteen](screenshot-twentynineteen.png)

On Twenty Seventeen:  

![Screenshot of active Maintenance mode on Twenty Seventeen](screenshot-twentyseventeen.png)

## Changelog

### 0.2.2

* Stop returning a 503 to Jetpack requests to prevent broken connection verification

### 0.2.1

* Stop returning a 503 to Nagios on WPCom and VipGo to prevent alerting as a server error

### 0.2.0

* Return a 503 header while maintenance mode is active (props benoitchantre)

* Add an admin bar notice when Maintenance Mode is on (props benoitchantre)

### 0.1.0

* Initial plugin