deltafactory

Lightweight debugging and profile plugin intended for use on production sites.

Debug Tools

Lightweight debugging and profile plugin intended for use on production sites.

Andy Fragen

This plugin sets the following debug constants in <code>wp-config.php</code> on plugin activation and removes them on plugin deactivation. Any errors will result in a PHP Exception being thrown. Debug constants per <a href="https://developer.wordpress.org/advanced-administration/debug/debug-wordpress/" rel="nofollow ugc">Debugging in WordPress</a>.
Default settings:
<pre><code>define( 'WP_DEBUG_LOG', true );
define( 'SCRIPT_DEBUG', true );
define( 'SAVEQUERIES', true );
</code></pre>
  
 @ini_set( ‘display_errors’, 1 ); is set when the plugin is active. <code>WP_DEBUG</code> is set to true when the plugin is first run, thereafter it can be turned off in the Settings.
The Settings page allows the user to set the following.
<pre><code>define( 'WP_DEBUG', true ); // Default on initial plugin installation.
define( 'WP_DEBUG_DISPLAY', false ); // Default when not declared is true.
define( 'WP_DISABLE_FATAL_ERROR_HANDLER', true ); // WordPress 5.2 WSOD Override.
</code></pre>
When the plugin is deactivated best efforts are made to re-add pre-existing constants to their former state. When the plugin is activated the default settings and any saved settings are restored.
This plugin uses the <a href="https://github.com/wp-cli/wp-config-transformer" rel="nofollow ugc">wp-cli/wp-config-transformer</a> command for writing constants to <code>wp-config.php</code>.
<a href="https://github.com/norcross/debug-quick-look" rel="nofollow ugc">Debug Quick Look</a> from Andrew Norcross is included with this plugin to assist in reading the debug.log file. If you already have this plugin installed you should delete it when WP Debugging is not active.
<a href="https://wordpress.org/plugins/query-monitor/" rel="ugc">Query Monitor</a> and <a href="https://wordpress.org/plugins/debug-bar/" rel="ugc">Debug Bar</a> plugins are optional dependencies to aid in debugging and troubleshooting. The notice for installation will recur 45 days after being dismissed.
If you have a non-standard location for your <code>wp-config.php</code> file you can use the filter <code>wp_debugging_config_path</code> to return the file path for your installation.
The filter <code>wp_debugging_add_constants</code> allows the user to add constants to <code>wp-config.php</code>.
The filter returns an array where the key is the name of the constant and the value is an array of data containing the value as a string and a boolean to indicate whether or not the value should be passed without quotes.
<pre><code>$my_constants = [
 'my_test_constant' =>
 [
 'value' => 'abc123',
 'raw' => false,
 ],
 'another_test_constant' => [ 'value' => 'true' ],
];
</code></pre>
The <code>value</code> option contains the constant’s value as a string.
The <code>raw</code> option means that instead of placing the value inside the config as a string it will become unquoted. The default is <code>true</code>. Set as <code>false</code> for non-boolean values.
Example:
<pre><code>add_filter(
 'wp_debugging_add_constants',
 function( $added_constants ) {
 $my_constants = [
 'my_test_constant' => [
 'value' => '124xyz',
 'raw' => false,
 ],
 'another_test_constant' => [ 'value' => 'true' ],
 ];
 return array_merge( $added_constants, $my_constants );
 },
 10,
 1
);
</code></pre>
This will create the following constants.
<pre><code>define( 'MY_TEST_CONSTANT', '124xyz' );
define( 'ANOTHER_TEST_CONSTANT', true );
</code></pre>
<h3>Development</h3>
PRs are welcome against the <a href="https://github.com/afragen/wp-debugging" rel="nofollow ugc">develop branch on GitHub</a>.

WP Debugging

This helps me support customers and get better debugging information about errors happening on their site without having to ask for sensitive login info. Simple and does a great job, I've used it or recommended it a dozen times in the last month.

Great support tool

I can't tell you the number of times I've had to handle a support request that involved a white screen. Thank you, @afragen, for building this awesome tool to help define constants for a file that isn't easily accessible without passing around credentials.

Super Handy!

Thanks for the useful plugin, we're going to start recommending this to our customers.

Useful Plugin

Thank you for this useful and beautiful plugin, helps me a lot.

Very useful

Quick access to the log files speeds up development!

Great plugin

With this plugin it's at last possible to debug a remote site wihtout having access to the cpanel!

Very useful!


Every time I come across an obscure problem on WordPress sites, I start looking for it by installing this plugin.Thanks to the developers for a great tool!


Perfect tool for debug.

Yet another one of your plugins that I love and use all the time!  Thank you.  (Side note: is there a place to buy you a coffee or donate for your time?)

Another great debugging plugin

A support/troubleshooting plugin for WordPress.

Debug Tools vs WP Debugging