wp_debug_mode()
Set PHP error reporting based on WordPress debug settings.
Uses three constants: WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. All three can be defined in wp-config.php. By default, WP_DEBUG and WP_DEBUG_LOG are set to false, and WP_DEBUG_DISPLAY is set to true.
When WP_DEBUG is true, all PHP notices are reported. WordPress will also display internal notices: when a deprecated WordPress function, function argument, or file is used. Deprecated code may be removed from a later version.
It is strongly recommended that plugin and theme developers use WP_DEBUG in their development environments.
WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
When WP_DEBUG_DISPLAY is true, WordPress will force errors to be displayed. WP_DEBUG_DISPLAY defaults to true. Defining it as null prevents WordPress from changing the global configuration setting. Defining WP_DEBUG_DISPLAY as false will force errors to be hidden.
When WP_DEBUG_LOG is true, errors will be logged to wp-content/debug.log. When WP_DEBUG_LOG is a valid path, errors will be logged to the specified file.
Errors are never displayed for XML-RPC, REST, ms-files.php, and Ajax requests.
Internal function — this function is designed to be used by the kernel itself. It is not recommended to use this function in your code.
Hooks from the function
Return
null
. Nothing (null).
Usage
wp_debug_mode();
Examples
#1 There are no examples.
This function is used by the kernel for error management and is not intended to be used in development.
Changelog
Since 3.0.0 | Introduced. |
Since 5.1.0 | WP_DEBUG_LOG can be a file path. |