function drupal_site_offline in Drupal 7

Same name and namespace in other branches

1. 4 includes/common.inc \drupal_site_offline()
2. 5 includes/common.inc \drupal_site_offline()
3. 6 includes/common.inc \drupal_site_offline()

Delivers a "site is under maintenance" message to the browser.

Page callback functions wanting to report a "site offline" message should return MENU_SITE_OFFLINE instead of calling drupal_site_offline(). However, functions that are invoked in contexts where that return value might not bubble up to menu_execute_active_handler() should call drupal_site_offline().

Related topics

File

includes/common.inc, line 725

Common functions that many Drupal modules will need to reference.

Code

function drupal_site_offline() {
  drupal_deliver_page(MENU_SITE_OFFLINE);
}