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>This WordPress plugin is a wrapper for the <a href="https://kint-php.github.io/kint/" rel="nofollow ugc">Kint</a> PHP Debugger utility version 1.x.  Now instead of using var_dump() or print_r(), you simply use d() with zero, nadda, no formatting required.</p>
<p>Use this tool when you are debugging your website, in place of <strong><a href="http://php.net/manual/en/function.var-dump.php" rel="nofollow ugc">var_dump()</a></strong>, <strong><a href="http://php.net/manual/en/function.print-r.php" rel="nofollow ugc">print_r()</a></strong> and <strong><a href="http://php.net/manual/en/function.debug-backtrace.php" rel="nofollow ugc">debug_backtrace()</a></strong>.</p>
<h4>Handy Tools</h4>
<p>Some handy tools just for the PHP Developer:</p>
<ul>
<li><code>d( $var );</code> to render a collapsible UI container which displays your variable data in “the most informative way”</li>
<li><code>ddd( $var );</code> same as d() except that it also executes <code>die()</code> to halt execution.</li>
</ul>
<p>Here are some variations of <code>d()</code> to give you the display you want:</p>
<ul>
<li><code>~d( $var );</code> outputs in plain text format.</li>
<li><code>+d( $var );</code> disregards depth level limits and outputs everything</li>
<li><code>!d( $var );</code> shows expanded rich output</li>
<li><code>-d( $var );</code> attempts to ob_clean() the previous output (dump something inside of HTML)</li>
</ul>
<h4>Profiler</h4>
<p>Kint even includes a naïve profiler, which can help you analyze which blocks of code take longer than others:</p>
<pre><code>Kint::dump( microtime() ); // just pass microtime()
sleep( 1 );
Kint::dump( microtime(), 'after sleep(1)' );
sleep( 2 );
ddd( microtime(), 'final call, after sleep(2)' );
</code></pre>
<p>See <a href="https://wordpress.org/extend/plugins/kint-php-debugger/screenshots/" rel="ugc">screenshot 2</a> for what is rendered out in your browser.</p>
<h3>Admin Bar</h3>
<p>“KINT ACTIVE” indicator displays in the WordPress admin bar to alert you when the plugin is active.</p>


Kint PHP Debugger

Really like to debug with Kint, and this plugin makes it much easier.



Useful

Love this plugin. Displays more than var_dump does and is so much easier to read the output. Handy toggle to display more information is very helpful. Love that ddd() option to display and stop execution. Thank you!!!



Improves Workflow and Troubleshooting

Thanks for this plugin. It makes debugging my arrays of arrays of arrays much simpler. ;)

Works great!

Saves a lot of time when writing plugins and themes.
Thanks!

Update 2/11/2021 - even though this plugin hasn't had any updated in more than 2 years, it is still working just great.

Does what it says

Kint is a modern and powerful PHP debugging helper, which requires zero-setup and replaces var_dump(), print_r() and debug_backtrace().

Debug This vs Kint PHP Debugger