r-debug.php

<?php
/*
Plugin Name: R Debug
Description: Set of helper dump functions for debug.
Author: Andrey "Rarst" Savchenko
Author URI: http://www.rarst.net/
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
 */

class R_Debug {

	/**
	 * List basic performance stats
	 *
	 * @param bool $visible display or only include in source
	 */
	static function list_performance( $visible = false ) {

		$stat = sprintf( '%d queries in %.3f seconds, using %.2fMB memory',
			get_num_queries(),
			timer_stop( 0, 3 ),
			memory_get_peak_usage() / 1024 / 1024
		);

		echo $visible ? $stat : "<!-- {$stat} -->";
	}

	/**
	 * List defined constants
	 *
	 * @param bool|string $filter limit to matching names or values
	 */
	static function list_constants( $filter = false ) {

		$constants   = get_defined_constants();

		if ( false !== $filter ) {

			$temp = array();

			foreach ( $constants as $key => $constant ) {

				if ( false !== stripos( $key, $filter ) || false !== stripos( $constant, $filter ) )
					$temp[$key] = $constant;
			}

			$constants = $temp;
		}

		ksort( $constants );
		var_dump( $constants );
	}

	/**
	 * List cron entries with time remaining till next run
	 */
	static function list_cron() {

		$cron  = _get_cron_array();

		echo '<pre>';

		foreach ( $cron as $time => $entry ) {

			$when ='<strong>In ' . human_time_diff( $time ) . '</strong> (' .  date( DATE_RSS, $time ) . ')';
			echo "<br />&gt;&gt;&gt;&gt;&gt;\t{$when}<br />";

			foreach ( array_keys( $entry ) as $function ) {

				echo "\t{$function}<br />";
			}
		}

		echo '</pre>';
	}

	/**
	 * Output hook info
	 *
	 * @param string $tag hook name
	 * @param array $hook hook data
	 */
	static function dump_hook( $tag, $hook ) {

		ksort( $hook );

		echo "<pre>&gt;&gt;&gt;&gt;&gt;\t<strong>{$tag}</strong><br />";

		foreach ( $hook as $priority => $functions ) {

			echo $priority;

			foreach ( $functions as $function ) {

				echo "\t";

				$callback = $function['function'];

				if ( is_string( $callback ) )
					echo $callback;

				elseif ( is_string( $callback[0] ) )
					echo $callback[0] . '::' . $callback[1];

				elseif ( is_object( $callback[0] ) )
					echo get_class( $callback[0] ) . '->' . $callback[1];

				echo (1 == $function['accepted_args']) ? '<br />' : " ({$function['accepted_args']}) <br />";
			}
		}

		echo '</pre>';
	}

	/**
	 * List hooks as currently defined
	 *
	 * @param bool|string $filter limit to matching names
	 */
	static function list_hooks( $filter = false ) {

		global $wp_filter;

		$skip_filter = empty($filter);
		$hooks       = $wp_filter;
		ksort( $hooks );

		foreach ( $hooks as $tag => $hook ) {

			if ( $skip_filter || false !== strpos( $tag, $filter ) )
				self::dump_hook( $tag, $hook );
		}
	}

	/**
	 * Enable live listing of hooks as they run
	 *
	 * @param bool|string $hook limit to matching names
	 */
	static function list_live_hooks( $hook = false ) {

		if ( false === $hook )
			$hook = 'all';

		add_action( $hook, array( __CLASS__, 'list_hook_details' ), - 1 );
	}

	/**
	 * Handler for live hooks output
	 *
	 * @param mixed $input
	 * @return mixed
	 */
	static function list_hook_details( $input = NULL ) {

		global $wp_filter;

		$tag = current_filter();

		if ( isset($wp_filter[$tag]) )
			self::dump_hook( $tag, $wp_filter[$tag] );

		return $input;
	}

	/**
	 * List active plugins
	 */
	static function list_plugins() {

		var_dump( get_option( 'active_plugins' ) );
	}

	/**
	 * List performed MySQL queries
	 */
	static function list_queries() {

		global $wpdb;

		if ( ! defined( 'SAVEQUERIES' ) || ! SAVEQUERIES ) {

			trigger_error( 'SAVEQUERIES needs to be defined', E_USER_NOTICE );
			return;
		}

		$queries = $wpdb->queries;

		echo '<pre>';

		foreach ( $queries as $query ) {

			list($request, $duration, $backtrace) = $query;
			$duration  = sprintf( '%f', $duration );
			$backtrace = trim( array_pop( explode( ',', $backtrace ) ) );

			if ( 'get_option' == $backtrace ) {

				preg_match_all( '/\option_name.*?=.*?\'(.+?)\'/', $request, $matches );
				$backtrace .= "({$matches[1][0]})";
			}

			echo "<br /><strong>{$request}</strong><br />{$backtrace} in {$duration}s<br />";
		}

		echo '</pre>';
	}
}