Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

wp_maintenance()

Die with a maintenance message when conditions are met.


Description Description

Checks for a file in the WordPress root directory named ".maintenance". This file will contain the variable $upgrading, set to the time the file was created. If the file was created less than 10 minutes ago, WordPress enters maintenance mode and displays a message.

The default message can be replaced by using a drop-in (maintenance.php in the wp-content directory).


Source Source

File: wp-includes/load.php

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
function wp_maintenance() {
    if ( ! file_exists( ABSPATH . '.maintenance' ) || wp_installing() ) {
        return;
    }
 
    global $upgrading;
 
    include( ABSPATH . '.maintenance' );
    // If the $upgrading timestamp is older than 10 minutes, don't die.
    if ( ( time() - $upgrading ) >= 600 ) {
        return;
    }
 
    /**
     * Filters whether to enable maintenance mode.
     *
     * This filter runs before it can be used by plugins. It is designed for
     * non-web runtimes. If this filter returns true, maintenance mode will be
     * active and the request will end. If false, the request will be allowed to
     * continue processing even if maintenance mode should be active.
     *
     * @since 4.6.0
     *
     * @param bool $enable_checks Whether to enable maintenance mode. Default true.
     * @param int  $upgrading     The timestamp set in the .maintenance file.
     */
    if ( ! apply_filters( 'enable_maintenance_mode', true, $upgrading ) ) {
        return;
    }
 
    if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) {
        require_once( WP_CONTENT_DIR . '/maintenance.php' );
        die();
    }
 
    wp_load_translations_early();
 
    $protocol = wp_get_server_protocol();
    header( "$protocol 503 Service Unavailable", true, 503 );
    header( 'Content-Type: text/html; charset=utf-8' );
    header( 'Retry-After: 600' );
 
    $dir_attr = '';
    if ( is_rtl() ) {
        $dir_attr = ' dir="rtl"';
    }
    ?>
    <!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml"<?php echo $dir_attr; ?>>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <title><?php _e( 'Maintenance' ); ?></title>
 
    </head>
    <body>
        <h1><?php _e( 'Briefly unavailable for scheduled maintenance. Check back in a minute.' ); ?></h1>
    </body>
    </html>
    <?php
    die();
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.