Maintenance mode helps to improve user experience by showing a notification when the site is going through maintenance. When the web application needs an update, it’s always a good idea to display a well-designed maintenance page instead of showing error on the website.<\/p>\n
CodeIgniter, itself doesn’t provide any functionality to setup maintenance mode. But there are many ways display a maintenance page in CodeIgniter<\/b>. In this tutorial, we will show you how to put the site in maintenance mode in CodeIgniter.<\/p>\n
CodeIgniter’s Hooks feature provides an ability to modify the core functionality without modifying the core files. You can easily setup maintenance page<\/b> or under construction page using hooks in CodeIgniter.<\/p>\n
Follow the below step-by-step guide to put your site in offline mode for maintenance in CodeIgniter.<\/p>\n
First all you need to enable hooks. Edit the Edit the To let the system know about the maintenance hook, edit the Create a new hook file called To display a well-designed maintenance page, create a Now you can enable the maintenance mode (offline) by settings Maintenance mode helps to improve user experience by showing a notification when the site is going through maintenance. When the web application needs an update, it’s always a good idea to display a well-designed maintenance <\/p>\n","protected":false},"author":1,"featured_media":3023,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[8],"tags":[55],"class_list":["post-3022","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-codeigniter","tag-codeigniter","cat-8-id","has_thumb"],"yoast_head":"\napplication\/config\/config.php<\/code> file and set $config['enable_hooks']<\/code> to TRUE<\/code>.<\/p>\n$config<\/span>[<\/span>'enable_hooks'<\/span>] = <\/span>TRUE<\/span>;<\/span><\/pre>\nDefine Maintenance Config<\/h2>\n
application\/config\/config.php<\/code> file and define a new config variable for maintenance mode. Insert the following code at the bottom of the config.php<\/code> file.<\/p>\n\/*
|--------------------------------------------------------------------------
| Maintenance Mode
|--------------------------------------------------------------------------
|
| For whatever reason sometimes a site needs to be taken offline.
| Set $config['maintenance_mode'] to TRUE if the site has to be offline
|
| $config['maintenance_mode'] = TRUE; \/\/ site is offline
| $config['maintenance_mode'] = FALSE; \/\/ site is online
*\/
<\/span>$config<\/span>[<\/span>'maintenance_mode'<\/span>] = <\/span>TRUE<\/span>;<\/span><\/pre>\nDefining Maintenance Hook<\/h2>\n
application\/config\/hooks.php<\/code> file and define hook.<\/p>\n\n
pre_system<\/code> – Hook point. The hook will be called very early during system execution.<\/li>\nclass<\/code> – The name of the class wish to invoke.<\/li>\nfunction<\/code> – The method name wish to call.<\/li>\nfilename<\/code> – The file name containing the class\/function.<\/li>\nfilepath<\/code> – The name of the directory containing hook script.<\/li>\n<\/ul>\n$hook<\/span>[<\/span>'pre_system'<\/span>][] = array(
<\/span>'class' <\/span>=> <\/span>'maintenance_hook'<\/span>,
<\/span>'function' <\/span>=> <\/span>'offline_check'<\/span>,
<\/span>'filename' <\/span>=> <\/span>'maintenance_hook.php'<\/span>,
<\/span>'filepath' <\/span>=> <\/span>'hooks'
<\/span>);<\/span><\/pre>\nMaintenance Hook Class<\/h2>\n
maintenance_hook.php<\/code> in the application\/hooks\/<\/code> folder and write Maintenance hook script. The following code checks whether site maintenance mode is ON and load the maintenance page from application views folder.<\/p>\n<?php <\/span>if ( ! <\/span>defined<\/span>(<\/span>'BASEPATH'<\/span>)) exit(<\/span>'No direct script access allowed'<\/span>);
<\/span>\/**
* Check whether the site is offline or not.
*
*\/
<\/span>class <\/span>Maintenance_hook
<\/span>{
public function <\/span>__construct<\/span>(){
<\/span>log_message<\/span>(<\/span>'debug'<\/span>,<\/span>'Accessing maintenance hook!'<\/span>);
}
public function <\/span>offline_check<\/span>(){
if(<\/span>file_exists<\/span>(<\/span>APPPATH<\/span>.<\/span>'config\/config.php'<\/span>)){
include(<\/span>APPPATH<\/span>.<\/span>'config\/config.php'<\/span>);
if(isset(<\/span>$config<\/span>[<\/span>'maintenance_mode'<\/span>]) && <\/span>$config<\/span>[<\/span>'maintenance_mode'<\/span>] === <\/span>TRUE<\/span>){
include(<\/span>APPPATH<\/span>.<\/span>'views\/maintenance.php'<\/span>);
exit;
}
}
}
}<\/span><\/pre>\nMaintenance Page<\/h2>\n
maintenance.php<\/code> file in the application\/views\/<\/code> directory and insert the HTML.<\/p>\n<?php defined<\/span>(<\/span>'BASEPATH'<\/span>) OR exit(<\/span>'No direct script access allowed'<\/span>); <\/span>?><\/span>\r\n<!DOCTYPE<\/span> html>\r\n<html<\/span> lang<\/span>=\"en\"<\/span>>\r\n<head<\/span>>\r\n <meta<\/span> charset<\/span>=\"utf-8\"<\/span>>\r\n <title<\/span>>Site Under Maintenance<\/title<\/span>>\r\n <link<\/span> href<\/span>=\"http:\/\/localhost\/codeigniter\/assets\/css\/style.css\"<\/span> rel<\/span>=\"stylesheet\"<\/span> type<\/span>=\"text\/css\"<\/span> \/>\r\n<\/head<\/span>>\r\n<body<\/span> class<\/span>=\"bg\"<\/span>>\r\n <h1<\/span> class<\/span>=\"head text-center\"<\/span>>Site Under Maintenance<\/h1<\/span>>\r\n <div<\/span> class<\/span>=\"container\"<\/span>>\r\n <div<\/span> class<\/span>=\"content1\"<\/span>> \r\n <img<\/span> src<\/span>=\"http:\/\/localhost\/codeigniter\/assets\/images\/2.png\"<\/span> alt<\/span>=\"under-construction\"<\/span>>\r\n <p<\/span> class<\/span>=\"text-center\"<\/span>>Sorry for the inconvenience. To improve our services, we have momentarily shutdown our site.<\/p<\/span>>\r\n <\/div<\/span>>\r\n <\/div<\/span>>\r\n<\/body<\/span>>\r\n<\/html<\/span>>\r\n<\/pre>\nEnable\/Disable Maintenance Mode<\/h2>\n
$config['maintenance_mode'] = TRUE;<\/code> To disable the maintenance mode (online), change it to $config['maintenance_mode'] = FALSE;<\/code><\/p>\n","protected":false},"excerpt":{"rendered":"