wp_debug_mode()

Description

Compatibility

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

Performance profile

How much work a call to wp_debug_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

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

6–62

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

Plugin surface

1 hook

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 21 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( enable_wp_debug_mode_checks )filterline 609 (+31 into the body)

   Filters whether to allow the debug mode check to occur.

Uses · 3

• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_doing_ajax()Determines whether the current request is a WordPress Ajax request.
• wp_is_json_request()Checks whether current request is a JSON request, or is expecting a JSON response.

Source code

View on Trac ↗View on GitHub ↗

578function wp_debug_mode() {579	/**580	 * Filters whether to allow the debug mode check to occur.581	 *582	 * This filter runs before it can be used by plugins. It is designed for583	 * non-web runtimes. Returning false causes the `WP_DEBUG` and related584	 * constants to not be checked and the default PHP values for errors585	 * will be used unless you take care to update them yourself.586	 *587	 * To use this filter you must define a `$wp_filter` global before588	 * WordPress loads, usually in `wp-config.php`.589	 *590	 * Example:591	 *592	 *     $GLOBALS['wp_filter'] = array(593	 *         'enable_wp_debug_mode_checks' => array(594	 *             10 => array(595	 *                 array(596	 *                     'accepted_args' => 0,597	 *                     'function'      => function() {598	 *                         return false;599	 *                     },600	 *                 ),601	 *             ),602	 *         ),603	 *     );604	 *605	 * @since 4.6.0606	 *607	 * @param bool $enable_debug_mode Whether to enable debug mode checks to occur. Default true.608	 */609	if ( ! apply_filters( 'enable_wp_debug_mode_checks', true ) ) {610		return;611	}612 613	if ( WP_DEBUG ) {614		error_reporting( E_ALL );615 616		if ( WP_DEBUG_DISPLAY ) {617			ini_set( 'display_errors', 1 );618		} elseif ( null !== WP_DEBUG_DISPLAY ) {619			ini_set( 'display_errors', 0 );620		}621 622		if ( in_array( strtolower( (string) WP_DEBUG_LOG ), array( 'true', '1' ), true ) ) {623			$log_path = WP_CONTENT_DIR . '/debug.log';624		} elseif ( is_string( WP_DEBUG_LOG ) ) {625			$log_path = WP_DEBUG_LOG;626		} else {627			$log_path = false;628		}629 630		if ( $log_path ) {631			ini_set( 'log_errors', 1 );632			ini_set( 'error_log', $log_path );633		}634	} else {635		error_reporting( E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR );636	}637 638	/*639	 * The 'REST_REQUEST' check here is optimistic as the constant is most640	 * likely not set at this point even if it is in fact a REST request.641	 */642	if ( defined( 'XMLRPC_REQUEST' ) || defined( 'REST_REQUEST' ) || defined( 'MS_FILES_REQUEST' )643		|| ( defined( 'WP_INSTALLING' ) && WP_INSTALLING )644		|| wp_doing_ajax() || wp_is_json_request()645	) {646		ini_set( 'display_errors', 0 );647	}648}

Changelog

Introduced in 3.0.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.0.4 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.