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.

Viktor Szépe

<h4>Only for development!</h4>
<h4>Now with OPcache memory consumption support</h4>
<p>This plugin dumps the colorized filenames and memory consumptions or file sizes after the normal WordPress HTML output, after the closing html tag. This generates invalid HTML but gives you an overview of loaded plugins and the current theme.</p>
<p><em>What’s running</em> lists all files parsed and executed by the PHP engine. It can be used for plugin or theme refactoring.</p>
<h4>Now you can highlight your own plugin and theme</h4>
<p>Provide a part of its path in wp-config.php:</p>
<pre><code>define( 'WHATS_RUNNING_HIGHLIGHT', 'wp-content/plugins/my-plugin' ); </code></pre>
<h4>Color codes</h4>
<ul>
<li>your code is highlighted with YELLOW background</li>
<li>plugin files are in BLUE</li>
<li>themes files are in ORANGE</li>
<li>files in the wp-includes directory are in GREEN</li>
<li>files in the wp-admin directory are in GREY</li>
<li>all other files are in RED</li>
<li>VIOLET bar after the filename represents the file size ( 0.5 kB/px )</li>
<li>DARK MAGENTA bar after the filename represents the OPcache memory consumption ( 1 kB/px )</li>
</ul>
<h4>Links</h4>
<p>You can watch <a href="https://core.trac.wordpress.org/ticket/28364" rel="nofollow ugc">WP core bug #28364</a> to get more information about <a href="https://github.com/szepeviktor/WPHW/blob/master/wp-entry-points.md" rel="nofollow ugc">WordPress entry points</a>.</p>
<p>You can find some documentaion here what makes a WordPress plugin efficient: https://github.com/szepeviktor/WPHW</p>
<p>Development of this plugin goes on on <a href="https://github.com/szepeviktor/whats-running" rel="nofollow ugc">GitHub</a>.</p>


What's running

Lists WordPress require() calls mainly for plugin code refactoring.

Debug This vs What's running