wp_is_recovery_mode(): bool
- Since
- 5.2.0
- Source
wp-includes/load.php:1138
Description
In this mode, plugins or themes that cause WSODs will be paused.
Compatibility
- WordPress
- since 5.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
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
Performance profile
How much work a call to wp_is_recovery_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
- Trivial
- Scaling
- Constant
- Instructions
- 5
- Plugin surface
- None
- Called by
- 8
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 5.
Nothing here hands control to plugin code.
8 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_is_recovery_mode() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 5 | wp_recovery_mode(), ->is_active() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 5 instructions, 5 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- wp_recovery_mode()Access the WordPress Recovery Mode instance.
- wp_recovery_mode()::is_active()
Used by · 8
- WP_Fatal_Error_Handler::display_default_error_template()Displays the default PHP error template.
- deactivate_plugins()Deactivates a single plugin or multiple plugins.
- login_header()Outputs the login page header.
- switch_theme()Switches the theme.
- wp_admin_bar_recovery_mode_menu()Adds a link to exit recovery mode when Recovery Mode is active.
- wp_get_active_and_valid_plugins()Retrieves an array of active and valid plugin files.
- wp_get_active_and_valid_themes()Retrieves an array of active and valid themes.
- wp_recovery_mode_nag()Displays a notice when the user is in recovery mode.
Source code
function wp_is_recovery_mode() { return wp_recovery_mode()->is_active();}Changelog
Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 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.