|
Description This plugin incorporates the pear php_debug library into wordpress. I started using Pear php_debug in an effort to speed up my development process By quickly making debug information available without too much hassle. I have modified library a bit to suit my need so It can't be swapped with with files from the original package. DOWNLOAD HERE Discuss this article on the forums. (8 posts)
Unfortunately php_debug only works in php5 so this plugin will only work in php5. I will happly incorporate another library that can work with php4 if someone sends me one. Please also note that I developed this plugin on wordpress 2.6 and can't guarantee that it will work on v2.5. This plugin makes use of some features only avaialable in the newest wordpress releases. This plugin unlike most operates from within a class. There are several options which can be set in the admin section 1. Debug Status: Overall this option allows you to enable and disable debugging entirely 2. Display Debugging for: Guests This option allows you to enable debugging when no user is logged in 3. The rest are a list of roles found in the sytem, eg. editor, contributor, administrator For each you have the following options: Admin & Front End, Admin Only, Front End Only, Disable 4. The plugin shows queries that were run by wordpress Please not that some queries run before the plugin is initialized 5. You can easly add debug information to the debugger by making use of several functions $oDebug = wp_pear_debug::get();;
$oDebug->add($variable); //add variable to debug
$oDebug->dump($array); //var_dump an array
$oDebug->queryRel($info); //add query related info
$oDebug->error($info); //add user error
//more options available in the pear::php_debug documentation
Debug information appears in a neat panel controlled by javascript. The options expand and collapse. The debug panel also has a close button to completely remove the debug panel. Note that the debug bar floats at the top right and will not disrupt your layout. TO ensure layout stability the mod is hard coded to use only the HTML Div Renderer
Installation - Upload folder wp-pear-debug to the /wp-content/plugins/ directory
- Activate the plugin through the 'Plugins' menu in WordPress
- Set the appropriate option under settings->Debugger admin menu
Frequently Asked Questions Does this plugin work with php4 No this plugin does not work with php4 because the debug library pear::php_debug is php5 only. However, If I am able to get a good debug library which works with php4 I will be happy to include it. This plugin uses wrapper classes that allows you to quickly switch between libraries. A possible structure would be 1. Lib/php4/debugversion/1.x.x/ 1. Lib/php5/debugversion/1.x.x/ All these would be options in the debug settings Do I need pear installed to get this working No, pear is not required for this plugin to work Who is this for I imagine this plugin will be most valuable to wordpress developers generally It will also be good for people who are having errors on their site. This plugin also measures script execution time so It is also good for people who want to measure the performance of their entire site or a specific part of their script. Can I see the library in action? You can see the pear demo here
Screenshots
The screnshot displays the admin section for the debug plugin. To the top right is the floating debug bar.
Arbitrary section Since the plugin is wrapped in a class it can easily be extended to add more functionality. The most promising possibility I have seen is the add_filter() method which I used to get the query information in the debug. Though I have not tested this thoroughly but the library also allows you to watch variables. Discuss this article on the forums. (8 posts) |
