{"id":15039914,"url":"https://github.com/automattic/maintenance-mode-wp","last_synced_at":"2026-03-17T16:12:38.150Z","repository":{"id":46160968,"uuid":"82227045","full_name":"Automattic/maintenance-mode-wp","owner":"Automattic","description":"Shut down your site for a little while and do some maintenance on it!","archived":false,"fork":false,"pushed_at":"2025-01-27T21:27:18.000Z","size":666,"stargazers_count":42,"open_issues_count":2,"forks_count":16,"subscribers_count":7,"default_branch":"develop","last_synced_at":"2025-01-30T01:04:15.082Z","etag":null,"topics":["maintenance-mode","wordpress","wordpress-plugin","wpvip-plugin"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Automattic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-16T21:17:46.000Z","updated_at":"2025-01-27T21:27:21.000Z","dependencies_parsed_at":"2024-12-28T23:33:02.876Z","dependency_job_id":null,"html_url":"https://github.com/Automattic/maintenance-mode-wp","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fmaintenance-mode-wp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fmaintenance-mode-wp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fmaintenance-mode-wp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Automattic%2Fmaintenance-mode-wp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Automattic","download_url":"https://codeload.github.com/Automattic/maintenance-mode-wp/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237192170,"owners_count":19269842,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maintenance-mode","wordpress","wordpress-plugin","wpvip-plugin"],"created_at":"2024-09-24T20:43:59.223Z","updated_at":"2026-03-17T16:12:38.143Z","avatar_url":"https://github.com/Automattic.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Maintenance Mode\n\nStable tag: 0.3.2  \nRequires at least: 6.4  \nTested up to: 6.9  \nLicense: GPLv2 or later  \nLicense URI: https://www.gnu.org/licenses/gpl-2.0.html  \nTags: maintenance-mode, maintenance  \nContributors: wpcomvip, automattic, benoitchantre, emrikol, philipjohn, GaryJ  \n\nShut down your site for a little while and do some maintenance on it!\n\n## Description\n\nEasily provide a holding maintenance page, including with a custom template, to site visitors. \n\n### Custom Template\n\nTo add a custom template and messaging:\n\n - Create a template in your theme's root folder named `template-maintenance-mode.php`.\n - This should be a simple HTML page that includes the message you want to show your visitors.\n - Note: the template should include `wp_head()` and `wp_footer()` calls.\n\nYou can also use the `vip_maintenance_mode_template_args` filter to adjust the file name and location of the custom template within your theme. \n\nFor instance, if you want it to live at `wp-content/themes/my-theme/plugin-templates/maintenance-mode-alt.php`, then add code like:\n\n~~~php\nadd_filter(\n\t'vip_maintenance_mode_template_args',\n\tfunction( $args ) {\n\t\t$args['slug'] = 'plugin-templates/maintenance-mode';\n\t\t$args['name'] = 'alt';\n\n\t\treturn $args;\n\t}\n);\n~~~\n\nThis also allows the third array key to be used to pass in custom arguments to the template.\n\n### Additional Configurations\n\nUsing 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.\n\n#### Selectively Load Maintenance Mode\nConfigure 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:\n\n~~~php\n$site_name = $_SERVER['SERVER_NAME'];\n$lockdown = false;\n\nif ( false !== strpos( $site_name, 'url-to-enable-maintentance-mode' ) ) {\n\t// Set lockdown\n\t$lockdown = true;\n}\n// Set maintenance plugin\ndefine( 'VIP_MAINTENANCE_MODE', $lockdown );\n~~~\n\n#### Enable WordPress REST API\nConfigure 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:\n\n~~~php\n// Generally allow API access\nadd_filter( 'vip_maintenance_mode_restrict_rest_api', '__return_false' );\n~~~\n\nYou can also choose to enable the REST API only in more narrow use-cases:\n\n~~~php\nadd_filter( 'vip_maintenance_mode_restrict_rest_api', 'x_mm_allow_api' );\n\nfunction x_mm_allow_api( $default ) {\n\tif ( my_check() ) { \n\t\treturn false;\n\t}\n\n\treturn true;\n}\n~~~\n\n## Installation\n\n1. Add the plugin to the `/plugins` directory of an application's GitHub repository.\n2. Define the `VIP_MAINTENANCE_MODE` constant as true in `vip-config/vip-config.php`.\n3. Activate the plugin in the WordPress Admin dashboard Plugins screen.\n\n## Screenshots\n\nOn Twenty Twenty-Five:  \n![Screenshot of active Maintenance mode on Twenty Twenty-Five](.wordpress-org/screenshot-8.png)\n\nOn Twenty Twenty-Four:  \n![Screenshot of active Maintenance mode on Twenty Twenty-Four](.wordpress-org/screenshot-7.png)\n\nOn Twenty Twenty-Three:  \n![Screenshot of active Maintenance mode on Twenty Twenty-Three](.wordpress-org/screenshot-6.png)\n\nOn Twenty Twenty-Two:  \n![Screenshot of active Maintenance mode on Twenty Twenty-Two](.wordpress-org/screenshot-5.png)\n\nOn Twenty Twenty-One:  \n![Screenshot of active Maintenance mode on Twenty Twenty-One](.wordpress-org/screenshot-4.png)\n\nOn Twenty Twenty:  \n![Screenshot of active Maintenance mode on Twenty Twenty](.wordpress-org/screenshot-3.png)\n\nOn Twenty Nineteen:  \n![Screenshot of active Maintenance mode on Twenty Nineteen](.wordpress-org/screenshot-2.png)\n\nOn Twenty Seventeen:  \n![Screenshot of active Maintenance mode on Twenty Seventeen](.wordpress-org/screenshot-1.png)\n\n## Changelog\n\nSee [the changelog](CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautomattic%2Fmaintenance-mode-wp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautomattic%2Fmaintenance-mode-wp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautomattic%2Fmaintenance-mode-wp/lists"}