WP_Upgrader::maintenance_mode() │ public │ WP 2.8.0

Toggles maintenance mode for the site.

Creates/deletes the maintenance file to enable/disable maintenance mode.

Method of the class: WP_Upgrader{}

No Hooks.

Return

null. Nothing (null).

Usage

$WP_Upgrader = new WP_Upgrader();
$WP_Upgrader->maintenance_mode( $enable );

$enable(true|false)

True to enable maintenance mode, false to disable.
Default: false

Notes

• Global. WP_Filesystem_Base. $wp_filesystem WordPress filesystem subclass.

Changelog

WP_Upgrader::maintenance_mode() WP Upgrader::maintenance mode code ^{WP 6.8}

<?php
public function maintenance_mode( $enable = false ) {
	global $wp_filesystem;

	if ( ! $wp_filesystem ) {
		require_once ABSPATH . 'wp-admin/includes/file.php';
		WP_Filesystem();
	}

	$file = $wp_filesystem->abspath() . '.maintenance';
	if ( $enable ) {
		if ( ! wp_doing_cron() ) {
			$this->skin->feedback( 'maintenance_start' );
		}
		// Create maintenance file to signal that we are upgrading.
		$maintenance_string = '<?php $upgrading = ' . time() . '; ?>';
		$wp_filesystem->delete( $file );
		$wp_filesystem->put_contents( $file, $maintenance_string, FS_CHMOD_FILE );
	} elseif ( ! $enable && $wp_filesystem->exists( $file ) ) {
		if ( ! wp_doing_cron() ) {
			$this->skin->feedback( 'maintenance_end' );
		}
		$wp_filesystem->delete( $file );
	}
}