WordPress at Your Fingertips
function is not described

WP_Upgrader::maintenance_mode() public WP 2.8.0

Toggle maintenance mode for the site.

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

{} It's a method of the class: WP_Upgrader{}

No Hooks.

Return

null. Nothing.

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 Subclass

Changelog

Since 2.8.0 Introduced.

Code of WP_Upgrader::maintenance_mode() WP 5.8.2

<?php
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 );
	}
}