WP_Upgrader::maintenance_mode( bool $enable = false )

Toggles maintenance mode for the site.


Description

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


Top ↑

Parameters

$enable bool Optional
True to enable maintenance mode, false to disable.

Default: false


Top ↑

Source

File: wp-admin/includes/class-wp-upgrader.php. View all references

public function maintenance_mode( $enable = false ) {
	global $wp_filesystem;
	$file = $wp_filesystem->abspath() . '.maintenance';
	if ( $enable ) {
		$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 ) ) {
		$this->skin->feedback( 'maintenance_end' );
		$wp_filesystem->delete( $file );
	}
}

Top ↑

Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

User Contributed Notes

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