WP Chill

Silkalns

Brian Fegter

Chris Dillon

Razvan Aldea

<p>For admins, developers, and support staff, <strong>Debug This</strong> provides a ton of information about your WordPress installation, all from the front-end admin bar.</p>
<ul>
<li><em>The current WP_Query object</em></li>
<li>Blog info and options</li>
<li>Embed providers</li>
<li>Files in rendered HTML (CSS, images, JavaScript)</li>
<li>Filters and actions</li>
<li>Images sizes</li>
<li>Globals and constants</li>
<li>Menus</li>
<li>Object cache stats</li>
<li>Plugins, must-use plugins, and dropins</li>
<li>Rewrite rules</li>
<li>Queries</li>
<li>PHP and server information</li>
<li>Post attachments</li>
<li>Post types</li>
<li>Scripts and styles enqueued</li>
<li>Shortcodes</li>
<li>Sidebars and widgets</li>
<li>Taxonomies and terms</li>
<li>Themes</li>
<li>Users</li>
<li>WP cron schedules and jobs</li>
<li>WP debug log</li>
</ul>
<p><strong>Debug This</strong> helps you save time and effort when trying to figure out what’s going on. Instead of hardcoding debug snippets or writing complex unit<br />
tests for small functionality, you can simply bring to the surface what you need right from the admin bar.</p>
<p>For example, when viewing a single post, you can see:</p>
<ul>
<li>a list of post attachments,</li>
<li>which menus and sidebars are being displayed,</li>
<li>the post type, post fields, and meta data,</li>
<li>the current query variables and query string,</li>
<li>the rewrite rules applied,</li>
<li>the author,</li>
<li>the terms,</li>
<li>and much more.</li>
</ul>
<h3>Extend</h3>
<h4>Debug This Functions</h4>
<p>New debug modes can be created easily:</p>
<pre><code>add_debug_extension(
    $mode,
    $menu_label,
    $description,
    $callback,
    $group = 'General'
);
</code></pre>
<p><strong>Example</strong></p>
<pre><code>add_debug_extension(
    'actions',
    __('Actions', 'debug-this'),
    __('$wp_actions contains all active registered actions', 'debug-this'),
    'foo_callback',
    'Filters And Actions'
);
function foo_callback($buffer, $template){
    global $wp_actions;
    $debug = print_r($wp_actions, true);
    return $debug;
}
</code></pre>
<p>You can add links to the header of a debug mode page. Place this code within your debug callback function.</p>
<pre><code>add_debug_header_link('http://urltolink', 'Link Label');
</code></pre>
<p>Extensions can be removed as well using <code>remove_debug_extension($mode);</code></p>
<p><strong>No PRE Tags</strong></p>
<p>If you don’t want your debug output to be enclosed in PRE tags, simply set the following in your extension:</p>
<pre><code>Debug_This::$no_pre = true;
</code></pre>
<p><strong>Saved Queries and Execution Time</strong></p>
<p>Retrieve saved queries and execution time by using the following static properties:</p>
<ul>
<li><code>Debug_This::$execution_time</code></li>
<li><code>Debug_This::$queries</code> – SAVEQUERIES must defined as true</li>
</ul>
<p><strong>URL Helpers</strong></p>
<ul>
<li><code>Debug_This::get_current_debug_url()</code> – current URL with the debug query</li>
<li><code>Debug_This::get_escape_url()</code> – used for the debug escape link that links to original page URL</li>
</ul>
<h4>WP Actions</h4>
<ul>
<li><code>debug_this</code> – receives the $mode arg – outputs the debug code sent from the extension modes. The default action is set to priority 5. This allows you to prepend or append any output without conflict using less or greater priorities.</li>
</ul>
<h4>WP Filters</h4>
<p>There are a few filters you can use to customize Debug This to your needs:</p>
<ul>
<li><code>debug_this_template</code> – receives $template arg – Use your own template</li>
<li><code>debug_this_default_mode</code>  – receives $mode arg – Alters the mode for the parent DT admin bar button link.</li>
<li><code>debug_this_output</code> – receives $output, $mode args – Filter debug content before it’s rendered</li>
</ul>
<h4>JavaScript</h4>
<p>To access the built-in Debug This JS functionality, enqueue your custom script with the dependency set to <code>debug-this</code>. Your script will inherit a jQuery dependency.</p>
<p><strong>Object: debugThis</strong></p>
<ul>
<li><code>debugThis.mode</code> – current mode</li>
<li><code>debugThis.defaultMode</code></li>
<li><code>debugThis.template</code> – current included template</li>
<li><code>debugThis.queryVar</code> – the defined query string variable</li>
</ul>
<p><strong>Functions:</strong></p>
<ul>
<li><code>isDebug()</code></li>
<li><code>getDebugMode()</code> – uses <code>isDebug()</code></li>
</ul>
<p><strong>Events:</strong></p>
<p>A jQuery <code>debug-this</code> event is fired from the footer. You can hook into this event with the following;</p>
<pre><code>jQuery(document).bind('debug-this', function(event, debugThis){
    console.log(debugThis);
});
</code></pre>
<h4>Helper Functions</h4>
<p>There are three included functions to help you work with files.</p>
<ul>
<li><code>debug_this_get_file_ownership($file)</code> – returns <code>array('name' => $name, 'group' => $group)</code></li>
<li><code>debug_this_get_file_perms($file)</code> – returns string – Example: 0775</li>
<li><code>debug_this_convert_perms_to_rwx($perms)</code> – returns string – converts permission number to RWX format – Example: 0755 folder becomes drwxr-xr-x</li>
</ul>


Debug This

Very nice, even the phpinfo() colors are displayed correctly.

Great plugin

Peek under the hood with sixty debugging reports just one click away.

Tonya Mork

<p>Debug Toolkit makes debugging your code easier and more enjoyable.  It provides you with interactive and helpful tools:</p>
<ul>
<li>Better PHP error interface from (<a href="http://filp.github.io/whoops/" rel="nofollow ugc">Whoops</a>)</li>
<li>Better variable inspection – no need to use <code>var_dump</code>, <code>print_r</code>, or X-debug</li>
<li>An interactive way to back trace the program’s execution order</li>
</ul>
<h3>Better PHP Error Interface from Whoops</h3>
<p>The built-in PHP error container is basic and not as helpful as it could be.  On top of that, it’s rather ugly. Wouldn’t you agree?</p>
<p>Whoops gives you a cool interface that is helpful, interactive, and quite nice to look at.  Some features:</p>
<ul>
<li>Provides the error message and links to search Google, DuckDuckGo, and Stack Overflow.</li>
<li>Shows the actual code where the error occurred.</li>
<li>Provides an interactive call stack.  Click each and the actual code appears in the viewer panel.</li>
<li>Environment and details including GET Data, POST Data, Files, Cookie, Session, Server/Request Data, Environment Variables, and Registered Handlers.</li>
</ul>
<p>See the tools in action in this video</p>
<p><iframe loading="lazy" title="Introducing the Debug Toolkit Plugin for WordPress" src="https://player.vimeo.com/video/322351688?dnt=1&app_id=122963" width="750" height="422" frameborder="0" allow="autoplay; fullscreen; picture-in-picture; clipboard-write"></iframe></p>
<h3>Better Variable Inspection</h3>
<p>Though X-debug is powerful, it can be difficult to set up and run.  For that reason, it’s common to dump or print out the variable to browser.  But the built-in display for the PHP <code>var_dump</code> and <code>print_r</code> is basic.</p>
<p>This plugin includes both two very popular variable dumper tools:</p>
<ul>
<li><a href="https://symfony.com/doc/current/components/var_dumper.html" rel="nofollow ugc">VarDumper from Symfony</a></li>
<li><a href="https://kint-php.github.io/kint/" rel="nofollow ugc">Kint – a modern and powerful PHP debugging helper</a></li>
</ul>
<p>VarDumper provides a simple container that displays where you place it.</p>
<p>On the other hand, Kint provides a more powerful interface that gives you more information such as printing out the expression that was passed into it, the data type, memory size, and the value.</p>
<p>To make it even easier, the following utility functions are available for you to use in your code:</p>
<h4>Available Functions for Inspecting Variable Values</h4>
<p>Let’s explore the functions that are available for you through this plugin.  We’ll use the variable inspectors to dump <code>global $post</code>.</p>
<p>Note: You can pass in any variable or function that returns a value.</p>
<p>Dumps the given variable(s):</p>
<pre><code>global $post;

// VarDumper
vdump( $post );

// Kint
dump( $post );
</code></pre>
<p>Dumps the given variable(s) and then exits the program’s execution:</p>
<pre><code>global $post;

// VarDumper
vdump_and_die( $post );

// Kint
dump_and_die( $post );
</code></pre>
<p>In addition, there are alias (shorthand) functions available for you if you prefer shorter function names:</p>
<ul>
<li><code>vd()</code> is an alias for <code>vdump()</code></li>
<li><code>vdd()</code> and <code>vdd()</code> are aliases for <code>vdump_and_die()</code></li>
<li><code>d()</code> is an alias for <code>dump()</code></li>
<li><code>dd()</code> and <code>ddd()</code> are aliases for <code>dump_and_die()</code></li>
</ul>
<h3>Tracing Call Stack</h3>
<p>When debugging, there are times when you need to see the order in which functions were called that lead to a certain point in the program.  PHP offers a backtrace that traces back the execution order from the point when the function is invoked.</p>
<p>To make backtracing easier, this plugin provides you with a <code>trace()</code> function and combines it with the variable inspect functions.</p>
<p>For example, if you wanted to trace the call stack to the start of the loop in your theme’s <code>functions.php</code> file, you could use this code:</p>
<pre><code>add_action( 'loop_start', function() {
    trace();
} );
</code></pre>
<h4>Available Trace Functions</h4>
<p>Place these functions at the point where you want to trace the call stack.</p>
<ul>
<li><code>trace();</code></li>
<li><code>trace_vdump();</code> – Combines <code>trace()</code> and <code>vdump()</code></li>
<li><code>trace_dump();</code> – Combines <code>trace()</code> and <code>dump()</code></li>
<li><code>trace_vdump_and_die();</code> – Combines <code>trace()</code> and <code>vdump_and_die()</code></li>
<li><code>trace_dump_and_die();</code> – Combines <code>trace()</code> and <code>dump_and_die()</code></li>
</ul>
<p>In addition, there are alias (shorthand) functions available for you if you prefer shorter function names:</p>
<ul>
<li><code>tracevd();</code> – Combines <code>trace()</code> and <code>vd()</code></li>
<li><code>traced();</code> – Combines <code>trace()</code> and <code>d()</code></li>
<li><code>tracevdd();</code> – Combines <code>trace()</code> and <code>vdd()</code></li>
<li><code>tracedd();</code> – Combines <code>trace()</code> and <code>dd()</code></li>
<li><code>tracevddd();</code> – Combines <code>trace()</code> and <code>vddd()</code></li>
<li><code>traceddd();</code> – Combines <code>trace()</code> and <code>ddd()</code></li>
</ul>
<h3>Admin Bar</h3>
<p>“DEBUG ACTIVE” indicator displays in the WordPress admin bar to alert you when the plugin is active.</p>


Debug Toolkit

This is a must have plugin if you do any kind of PHP coding for WordPress. It makes the difficult aspects of debugging code easy. You'll spend less time debugging and more time writing great functionality.

Very Nice!! A must have...

Thanks for creating this. Another must have in my plugin development workflow!

Another must have!

I've just discovered this plugin after years of WP development and it's super useful! I'm not a fan of xDebugging variables; debugging big objects and arrays with dump() or vdump() is very cool, as you can easily open up and close the tree to navigate through it more easily.
Nice work!

Excellent developer companion plugin

Wonderful plugin to debug errors. A feature request would be to dump the variable in debug.log file as well when define( 'WP_DEBUG_LOG', true ); is set in config file.

Wonderful Plugin

This is a great new plugin, and I love having the option to use Kint or VarDumper, they're invaluable. Having Whoops in there is a major plus. Tonya rocks!

Part of my build setup on every site now.

A must have!

This plugin is amazing, Highly recommended for developers. 

Really worth it !

One of my favourite plugin. Helps a lot with development and debugging. Please keep it update or if we could get a chance to contribute we would love that.

Best Plugin For Devs


This is a must have developers tool. Can't work without it. Highly recommend it.


Saved me many times

Code debug made easier and more enjoyable.

Debug This vs Debug Toolkit