Description
This simple and lightweight WordPress maintenance plugin puts the site into maintenance mode. The major advantage, compared to existing plugins, is that there are no options, it is ready to use!
It was think, while in maintenance mode, to :
– Not impact your SEO by sending a ‘503 Service Unavailable’ status to all unauthenticated clients. This means that it will inhibits search engines from both losing your site’s existing content and indexing your maintenance page as well, so your site will not lose its rankings while it is out of service. Content will even be hidden from consumers of the site’s RSS or Atom feeds.
– Make continually work the login/loggout process.
– It handle the activate process in multisite, which a lot of existing plugins don’t.
– If people are logged in they will have the site displayed as normal/expected.
How ?
We would like to precise that this plugin is simple as pie, anyone can use it but still dev-oriented. The idea is to not have a bunch of options to set before using it, in fact not only one! Because, it is a really pain when working on a multisite.
That is why there as still two filter for developers, which come in the section below.
IPs whitelist
In certain conditions, it is useful to not trigger the maintenance mode. That’s why you can add a file to your project (mu-plugins) to specify a range of IPs to whitelist. At the agency we use it with our VPN IP.
Please find an example of implementation on the following github;
Customize the maintenance mode template
By default it is the file located in the templates folder : maintenance.php
But you can customize this template using the following implementation on github, with a custom template placed wherever you want.
Composer
It is possible to activate the plugin by composer wp plugin activate beapi-maitenance-mode [--network]
If you are a developer and the plugin is not installed, you could also just use a dedicated composer command.
Who ?
Created by Be API, the French WordPress leader agency since 2009. Based in Paris, we are more than 30 people and always hiring some fun and talented guys. So we will be pleased to work with you.
This plugin is only maintained, which means we do not guarantee some free support. Consider reporting an issue and be patient.
To facilitate the process of submitting an issue and quicker answer, we only use Github, so don’t use WP.Org support, it will not be considered.
Screenshots
BEAPI Maintenance Mode triggered on site display.
Installation
Requirements
- Tested up to 4.9.8
- PHP 5.6+
WordPress
- Download and install using the built-in WordPress plugin installer.
- Site activate in the “Plugins” area of the admin.
FAQ
- Do I have something to configure ?
-
No.
That is the main “feature” of this plugin. It is ready to use and it is pretty useful when working with multisite.
- Can I use into a multisite ?
-
Yes.
You just need to activate on each site or network wide, depending on the needs.
- How can I add my IPs to whitelist ?
-
Just follow the referring note into the plugin documentation.
- How can I change the template displayed in case of maintenance ?
-
Just follow the referring note into the plugin documentation.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“BEAPI – Maintenance Mode” is open source software. The following people have contributed to this plugin.
Contributors
“BEAPI – Maintenance Mode” has been translated into 1 locale. Thank you to the translators for their contributions.
Translate “BEAPI – Maintenance Mode” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.5 – 02 Apr 2019
- Add #8 : filter is maintenance mode helper for handle custom behaviour.
1.0.4 – 06 Nov 2018
- Pimp my html
1.0.3 – 05 Nov 2018
- Released on wp.org
1.0.1 – 02 Nov 2018
- Add #2 : customize the maintenance mode template.
- Add #1 : add whitelisted IPs.
- Add #4 : implement maintenance mode to not disturb the wp-activate process.
1.0.0 – 02 Nov 2018
- First release