wp-maintenance-mode
Last commit date
assets
9 years ago
includes
9 years ago
languages
9 years ago
views
9 years ago
index.php
9 years ago
readme.md
9 years ago
readme.txt
9 years ago
uninstall.php
9 years ago
wp-maintenance-mode.php
9 years ago
readme.md
106 lines
| 1 | # Version 2.0.6 |
| 2 | |
| 3 | # WP Maintenance Mode |
| 4 | |
| 5 | Adds a splash page to your site that lets visitors know your site is down for maintenance. It's perfect for a coming soon page. |
| 6 | |
| 7 | **Features** |
| 8 | |
| 9 | * Fully customizable (change colors, texts and backgrounds); |
| 10 | * Subscription form (export emails to .csv file); |
| 11 | * Countdown timer (remaining time); |
| 12 | * Contact form (receive emails from visitors); |
| 13 | * Coming soon page; |
| 14 | * Landing page templates; |
| 15 | * WordPress multisite; |
| 16 | * Responsive design; |
| 17 | * Social media icons; |
| 18 | * Works with any WordPress theme; |
| 19 | * SEO options; |
| 20 | * Exclude URLs from maintenance. |
| 21 | |
| 22 | **Credits** |
| 23 | |
| 24 | Developed by [](http://designmodo.comDesignmodo](http://designmodo.com](http://designmodo.com) |
| 25 | |
| 26 | ## F.A.Q. |
| 27 | |
| 28 | **How to use plugin filters** |
| 29 | |
| 30 | `wpmm_backtime` - can be used to change the backtime from page `Retry-After` header |
| 31 | |
| 32 | ```php |
| 33 | function new_backtime() { |
| 34 | return 1800; |
| 35 | } |
| 36 | |
| 37 | add_filter('wpmm_backtime', 'new_backtime'); |
| 38 | ``` |
| 39 | |
| 40 | Now... the search bots will retry to visit the page after 1800 seconds. |
| 41 | |
| 42 | `wpmm_search_bots` - if you have `Bypass for Search Bots` option (from General) activated, it can be used to add / delete bots (useragents) |
| 43 | |
| 44 | ```php |
| 45 | function new_search_bots($bots) { |
| 46 | // we delete a bot from array |
| 47 | if(!empty($bots['AcoiRobot'])){ |
| 48 | unset($bots['AcoiRobot']); |
| 49 | } |
| 50 | |
| 51 | // we add a new bot into array |
| 52 | if(empty($bots['new_robot'])){ |
| 53 | $bots['new_robot'] = 'NewRobot'; // NewRobot is the user agent |
| 54 | } |
| 55 | |
| 56 | return $bots; |
| 57 | } |
| 58 | |
| 59 | add_filter('wpmm_search_bots', 'new_search_bots'); |
| 60 | ``` |
| 61 | |
| 62 | We deleted a bot from list and added a new one. |
| 63 | |
| 64 | `wpmm_text` - can be used to change `Text` option |
| 65 | |
| 66 | ```php |
| 67 | function new_text($text) { |
| 68 | $text = str_replace('http://www.designmodo.com', 'http://designmodo.com', $text); |
| 69 | |
| 70 | |
| 71 | return $text; |
| 72 | } |
| 73 | |
| 74 | add_filter('wpmm_text', 'new_text'); |
| 75 | ``` |
| 76 | |
| 77 | We replaced a string with another string. We can also add another text, add some extra html, etc. |
| 78 | |
| 79 | `wpmm_styles` - can be used to embed new css files |
| 80 | |
| 81 | ```php |
| 82 | function new_css_styles($styles) { |
| 83 | $styles['new-style'] = 'path_to_css_file/style.css'; // replace with the real path :) |
| 84 | |
| 85 | return $styles; |
| 86 | } |
| 87 | |
| 88 | add_filter('wpmm_styles', 'new_css_styles'); |
| 89 | ``` |
| 90 | |
| 91 | We embedded a new css style on maintenance page. Same mechanism can be used for javascript files (see `wpmm_scripts` filter). |
| 92 | |
| 93 | **Cache Plugin Support** |
| 94 | |
| 95 | WP Maintenance Mode can be unstable due the cache plugins, we recommend to deactivate any cache plugin when maintenance mode is active. |
| 96 | |
| 97 | ## Other Notes |
| 98 | ### License |
| 99 | Good news, this plugin is free for everyone! Since it's released under the GPL, you can use it free of charge on your personal or commercial blog. |
| 100 | |
| 101 | ### Translations |
| 102 | The plugin comes with various translations, please refer to the [](http://codex.wordpress.org/Installing_WordPress_in_Your_Language "Installing WordPress in Your Language"WordPress Codex](http://codex.wordpress.org/Installing_WordPress_in_Your_Language "Installing WordPress in Your Language"](http://codex.wordpress.org/Installing_WordPress_in_Your_Language "Installing WordPress in Your Language") for more information about activating the translation. If you want to help to translate the plugin to your language, please have a look at the .pot file which contains all defintions and may be used with a [](http://www.gnu.org/software/gettext/gettext](http://www.gnu.org/software/gettext/](http://www.gnu.org/software/gettext/) editor like [](http://www.poedit.net/Poedit](http://www.poedit.net/](http://www.poedit.net/) (Linux, Mac OS X, Windows). |
| 103 | |
| 104 | ### Contact & Feedback |
| 105 | Please let me know if you like the plugin or you hate it or whatever... Please fork it, add an issue for ideas and bugs. |
| 106 |