deltafactory

<p>Lightweight debugging and profile plugin intended for use on production sites.</p>


Debug Tools

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

Brian Fegter

Chris Dillon

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 Tools vs Kint Debugger