wp_is_maintenance_mode(): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

bool

True if maintenance mode is enabled, false otherwise.

Performance profile

How much work a call to wp_is_maintenance_mode() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

8–55

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 59.

Plugin surface

1 hook

Third-party callbacks on 'enable_maintenance_mode' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_is_maintenance_mode() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wp_is_maintenance_mode() runs, in this order:

1. 1
   apply_filters( enable_maintenance_mode )filterline 474 (+37 into the body)

   Filters whether to enable maintenance mode.

Uses · 2

• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• WP_Fatal_Error_Handler::handle()Runs the shutdown handler.
• wp_maintenance()Dies with a maintenance message when conditions are met.

Source code

View on Trac ↗View on GitHub ↗

437function wp_is_maintenance_mode() {438	global $upgrading;439 440	if ( ! file_exists( ABSPATH . '.maintenance' ) || wp_installing() ) {441		return false;442	}443 444	require ABSPATH . '.maintenance';445 446	// If the $upgrading timestamp is older than 10 minutes, consider maintenance over.447	if ( ( time() - $upgrading ) >= 10 * MINUTE_IN_SECONDS ) {448		return false;449	}450 451	// Don't enable maintenance mode while scraping for fatal errors.452	if ( is_int( $upgrading ) && isset( $_REQUEST['wp_scrape_key'], $_REQUEST['wp_scrape_nonce'] ) ) {453		$key   = stripslashes( $_REQUEST['wp_scrape_key'] );454		$nonce = stripslashes( $_REQUEST['wp_scrape_nonce'] );455 456		if ( md5( $upgrading ) === $key && (int) $nonce === $upgrading ) {457			return false;458		}459	}460 461	/**462	 * Filters whether to enable maintenance mode.463	 *464	 * This filter runs before it can be used by plugins. It is designed for465	 * non-web runtimes. If this filter returns true, maintenance mode will be466	 * active and the request will end. If false, the request will be allowed to467	 * continue processing even if maintenance mode should be active.468	 *469	 * @since 4.6.0470	 *471	 * @param bool $enable_checks Whether to enable maintenance mode. Default true.472	 * @param int  $upgrading     The timestamp set in the .maintenance file.473	 */474	if ( ! apply_filters( 'enable_maintenance_mode', true, $upgrading ) ) {475		return false;476	}477 478	return true;479}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/load.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.