Dashboard

Editing: MaintenanceModeCommand.php

<?php

namespace WP_CLI\MaintenanceMode;

use WP_CLI;
use WP_CLI_Command;
use WP_Upgrader;
use WP_Filesystem_Base;

/**
 * Activates, deactivates or checks the status of the maintenance mode of a site.
 *
 * ## EXAMPLES
 *
 *     # Activate Maintenance mode.
 *     $ wp maintenance-mode activate
 *     Enabling Maintenance mode...
 *     Success: Activated Maintenance mode.
 *
 *     # Deactivate Maintenance mode.
 *     $ wp maintenance-mode deactivate
 *     Disabling Maintenance mode...
 *     Success: Deactivated Maintenance mode.
 *
 *     # Display Maintenance mode status.
 *     $ wp maintenance-mode status
 *     Maintenance mode is active.
 *
 *     # Get Maintenance mode status for scripting purpose.
 *     $ wp maintenance-mode is-active
 *     $ echo $?
 *     1
 *
 * @when    after_wp_load
 * @package wp-cli
 */
class MaintenanceModeCommand extends WP_CLI_Command {

/**
	 * Instance of WP_Upgrader.
	 *
	 * @var WP_Upgrader
	 */
	private $upgrader;

/**
	 * Instantiate a MaintenanceModeCommand object.
	 */
	public function __construct() {
		if ( ! class_exists( 'WP_Upgrader' ) ) {
			require_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
		}
		$this->upgrader = new WP_Upgrader( new WP_CLI\UpgraderSkin() );
		$this->upgrader->init();
	}

/**
	 * Activates maintenance mode.
	 *
	 * ## OPTIONS
	 *
	 * [--force]
	 * : Force maintenance mode activation operation.
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp maintenance-mode activate
	 *     Enabling Maintenance mode...
	 *     Success: Activated Maintenance mode.
	 */
	public function activate( $_, $assoc_args ) {
		if ( $this->get_maintenance_mode_status() && ! WP_CLI\Utils\get_flag_value( $assoc_args, 'force' ) ) {
			WP_CLI::error( 'Maintenance mode already activated.' );
		}

$this->upgrader->maintenance_mode( true );
		WP_CLI::success( 'Activated Maintenance mode.' );
	}

/**
	 * Deactivates maintenance mode.
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp maintenance-mode deactivate
	 *     Disabling Maintenance mode...
	 *     Success: Deactivated Maintenance mode.
	 */
	public function deactivate() {
		if ( ! $this->get_maintenance_mode_status() ) {
			WP_CLI::error( 'Maintenance mode already deactivated.' );
		}

$this->upgrader->maintenance_mode( false );
		WP_CLI::success( 'Deactivated Maintenance mode.' );
	}

/**
	 * Displays maintenance mode status.
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp maintenance-mode status
	 *     Maintenance mode is active.
	 */
	public function status() {
		$status = $this->get_maintenance_mode_status() ? 'active' : 'not active';
		WP_CLI::line( "Maintenance mode is {$status}." );
	}

/**
	 * Detects maintenance mode status.
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp maintenance-mode is-active
	 *     $ echo $?
	 *     1
	 *
	 * @subcommand is-active
	 */
	public function is_active() {
		WP_CLI::halt( $this->get_maintenance_mode_status() ? 0 : 1 );
	}

/**
	 * Returns status of maintenance mode.
	 *
	 * @return bool
	 */
	private function get_maintenance_mode_status() {
		$wp_filesystem = $this->init_wp_filesystem();

$maintenance_file = trailingslashit( $wp_filesystem->abspath() ) . '.maintenance';

if ( ! $wp_filesystem->exists( $maintenance_file ) ) {
			return false;
		}

// We use the timestamp defined in the .maintenance file
		// to check if the maintenance is available.
		$upgrading = 0;

$contents = $wp_filesystem->get_contents( $maintenance_file );
		$matches  = [];
		if ( preg_match( '/upgrading\s*=\s*(\d+)\s*;/i', $contents, $matches ) ) {
			$upgrading = (int) $matches[1];
		} else {
			WP_CLI::warning( 'Unable to read the maintenance file timestamp, non-numeric value detected.' );
		}
		// The logic here is based on the core WordPress `wp_is_maintenance_mode()` function.
		if ( ( time() - $upgrading ) >= 10 * MINUTE_IN_SECONDS ) {
			return false;
		}
		return true;
	}

/**
	 * Initializes WP_Filesystem.
	 *
	 * @return WP_Filesystem_Base
	 */
	protected function init_wp_filesystem() {
		global $wp_filesystem;
		WP_Filesystem();

return $wp_filesystem;
	}
}

Cancel

Dashboard

Log In

Powered by WordPress