Silkalns

WP Chill

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.

Chris Wallace

<blockquote>
<p>This plugin is up for adoption.</p>
</blockquote>
<p><strong>Kint Debugger</strong> is a simple wrapper for <a href="https://github.com/raveren/kint" rel="nofollow ugc">Kint</a>, a debugging tool to output information about variables and traces in a styled, collapsible format that makes understanding deep arrays and objects easier.</p>
<p><em>No more adding PRE tags before print_r or var_dump!</em></p>
<p>Kint Debugger works well with the <a href="https://wordpress.org/plugins/debug-bar/" rel="ugc">Debug Bar</a> plugin by creating its own panel to display your debug results.</p>
<h4>Basic Usage</h4>
<pre><code><?php d( $var ); ?>
</code></pre>
<p>Examples:</p>
<pre><code><?php
    global $post;
    $term_list = wp_get_post_terms( $post->ID, 'my_taxonomy', array( 'fields' => 'all' ) );
    d( $term_list );
?>
</code></pre>
<p>Kint Debugger also provides some helper functions for dumping variables that are frequently needed.</p>
<ul>
<li><code>dump_wp_query()</code></li>
<li><code>dump_wp()</code></li>
<li><code>dump_post()</code></li>
<li><code>dump_this( $var, $inline = false )</code> – explained below</li>
</ul>
<p>Examples:</p>
<pre><code><?php dump_post(); ?>

<?php add_action( 'wp_head', 'dump_post' ); ?>
</code></pre>
<p>Obviously, if this plugin is not active, calls to the helper functions will cause errors.</p>
<h4>Your Own Functions</h4>
<p>If you are dumping the same information in different places, consider writing your own helper functions in your theme’s functions file or an mu-plugin. For example:</p>
<pre><code><?php
function my_dump_terms() {
     global $post;
     $term_list = wp_get_post_terms( $post->ID, 'my_taxonomy', array( 'fields' => 'all' ) );
     d( $term_list  );
}
?>
</code></pre>
<p>Then at strategic points in your theme or plugin:</p>
<pre><code><?php my_dump_terms(); ?>
</code></pre>
<h4>With Debug Bar</h4>
<p>By default, when <a href="https://wordpress.org/plugins/debug-bar/" rel="ugc">Debug Bar</a> is installed and active, Kint Debugger will send d() output to its Debug Bar panel.</p>
<p>To print debug output inline instead, as if Debug Bar was not active, declare the constant KINT_TO_DEBUG_BAR in your config.php (or really anywhere before your d() call):</p>
<pre><code>define( 'KINT_TO_DEBUG_BAR', false );
</code></pre>
<p>Or to print a specific dump inline, use a helper function with the parameter <code>$inline</code>. The generic <code>dump_this()</code> takes <code>$inline</code> as the second parameter.</p>
<p>Examples:</p>
<pre><code><?php dump_post( true ); ?>

<?php
    global $post;
    $term_list = wp_get_post_terms( $post->ID, 'my_taxonomy', array( 'fields' => 'all' ) );
    dump_this( $term_list , true );
?>
</code></pre>
<p>Kint Debugger overrides Kint’s d() function in order to buffer its output for Debug Bar. If you already have a modified d() function, you need to prevent the override in one of two ways.</p>
<ol>
<li>Move your modified d() function to an mu-plugin. Kint Debugger checks if the function exists before declaring it so putting yours in an mu-plugin is the only way to ensure it exists first.</li>
<li>Declare KINT_TO_DEBUG_BAR as described above.</li>
</ol>
<h4>Restricting Output</h4>
<p>To restrict visibility, use the <code>kint_debug_display</code> filter. For example, to prevent non-admins from seeing the debug output:</p>
<pre><code>add_filter( 'kint_debug_display', function( $allow ) { return is_super_admin(); } );
</code></pre>
<h4>Try these plugins too</h4>
<ul>
<li><a href="https://wordpress.org/plugins/what-the-file/" rel="ugc">What The File</a> – Identify template files without fail.</li>
<li><a href="https://wordpress.org/plugins/debug-this/" rel="ugc">Debug This</a> – Peek under the hood with sixty debugging reports just one click away.</li>
</ul>


Kint Debugger

Dump variables and traces in an organized and interactive display. Integrates seamlessly with Debug Bar.

Debug This vs Kint Debugger