Title: Debug Toolkit Author: Tonya Mork Published: Març 9, 2019 Last modified: Març 11, 2019 --- Search plugins ![](https://ps.w.org/debug-toolkit/assets/banner-772x250.png?rev=2047222) This plugin **hasn’t been tested with the latest 3 major releases of WordPress**. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress. ![](https://ps.w.org/debug-toolkit/assets/icon-256x256.png?rev=2047222) # Debug Toolkit By [Tonya Mork](https://profiles.wordpress.org/hellofromtonya/) [Download](https://downloads.wordpress.org/plugin/debug-toolkit.1.0.1.zip) * [Details](https://bal.wordpress.org/plugins/debug-toolkit/#description) * [Reviews](https://bal.wordpress.org/plugins/debug-toolkit/#reviews) * [Installation](https://bal.wordpress.org/plugins/debug-toolkit/#installation) * [Development](https://bal.wordpress.org/plugins/debug-toolkit/#developers) [Support](https://wordpress.org/support/plugin/debug-toolkit/) ## Description Debug Toolkit makes debugging your code easier and more enjoyable. It provides you with interactive and helpful tools: * Better PHP error interface from ([Whoops](http://filp.github.io/whoops/)) * Better variable inspection – no need to use `var_dump`, `print_r`, or X-debug * An interactive way to back trace the program’s execution order ### Better PHP Error Interface from Whoops The built-in PHP error container is basic and not as helpful as it could be. On top of that, it’s rather ugly. Wouldn’t you agree? Whoops gives you a cool interface that is helpful, interactive, and quite nice to look at. Some features: * Provides the error message and links to search Google, DuckDuckGo, and Stack Overflow. * Shows the actual code where the error occurred. * Provides an interactive call stack. Click each and the actual code appears in the viewer panel. * Environment and details including GET Data, POST Data, Files, Cookie, Session, Server/Request Data, Environment Variables, and Registered Handlers. See the tools in action in this video ### Better Variable Inspection Though X-debug is powerful, it can be difficult to set up and run. For that reason, it’s common to dump or print out the variable to browser. But the built-in display for the PHP `var_dump` and `print_r` is basic. This plugin includes both two very popular variable dumper tools: * [VarDumper from Symfony](https://symfony.com/doc/current/components/var_dumper.html) * [Kint – a modern and powerful PHP debugging helper](https://kint-php.github.io/kint/) VarDumper provides a simple container that displays where you place it. On the other hand, Kint provides a more powerful interface that gives you more information such as printing out the expression that was passed into it, the data type, memory size, and the value. To make it even easier, the following utility functions are available for you to use in your code: #### Available Functions for Inspecting Variable Values Let’s explore the functions that are available for you through this plugin. We’ll use the variable inspectors to dump `global $post`. Note: You can pass in any variable or function that returns a value. Dumps the given variable(s): ``` global $post; // VarDumper vdump( $post ); // Kint dump( $post ); ``` Dumps the given variable(s) and then exits the program’s execution: ``` global $post; // VarDumper vdump_and_die( $post ); // Kint dump_and_die( $post ); ``` In addition, there are alias (shorthand) functions available for you if you prefer shorter function names: * `vd()` is an alias for `vdump()` * `vdd()` and `vdd()` are aliases for `vdump_and_die()` * `d()` is an alias for `dump()` * `dd()` and `ddd()` are aliases for `dump_and_die()` ### Tracing Call Stack When debugging, there are times when you need to see the order in which functions were called that lead to a certain point in the program. PHP offers a backtrace that traces back the execution order from the point when the function is invoked. To make backtracing easier, this plugin provides you with a `trace()` function and combines it with the variable inspect functions. For example, if you wanted to trace the call stack to the start of the loop in your theme’s `functions.php` file, you could use this code: ``` add_action( 'loop_start', function() { trace(); } ); ``` #### Available Trace Functions Place these functions at the point where you want to trace the call stack. * `trace();` * `trace_vdump();` – Combines `trace()` and `vdump()` * `trace_dump();` – Combines `trace()` and `dump()` * `trace_vdump_and_die();` – Combines `trace()` and `vdump_and_die()` * `trace_dump_and_die();` – Combines `trace()` and `dump_and_die()` In addition, there are alias (shorthand) functions available for you if you prefer shorter function names: * `tracevd();` – Combines `trace()` and `vd()` * `traced();` – Combines `trace()` and `d()` * `tracevdd();` – Combines `trace()` and `vdd()` * `tracedd();` – Combines `trace()` and `dd()` * `tracevddd();` – Combines `trace()` and `vddd()` * `traceddd();` – Combines `trace()` and `ddd()` ### Admin Bar “DEBUG ACTIVE” indicator displays in the WordPress admin bar to alert you when the plugin is active. ## Screenshots * [[ * The better PHP error interface from Whoops. * [[ * The results of running `vdump()` and `vdump_and_die()`. * [[ * The results of running `dump()` and `dump_and_die()`. * [[ * The results of running `trace()`. ## Installation #### From your WordPress dashboard 1. Visit ‘Plugins > Add New’ 2. Search for ‘Debug Toolkit’ 3. Activate Debug Toolkit from your Plugins page. ## FAQ How do I use this utility? When you are testing or debugging your code, you can use any of the functions above in place of var_dump( $var ) and print_r( $var ). No need to wrap it in pre’s either. What version of PHP do I need? PHP 5.6, 7.0, 7.1, 7.2, and up. Can I run this on a live site? I wouldn’t unless you are testing. This tool is for debug only. Once you push the site live, deactivate and delete this plugin. What should I do when the site goes live? Deactivate and delete this plugin. ## Reviews ![](https://secure.gravatar.com/avatar/1869c78748b20262a81dfbaa8538423bdea3d892e29648c99e9632262ed78d66? s=60&d=retro&r=g) ### 󠀁[Saved me many times](https://wordpress.org/support/topic/saved-me-many-times-2/)󠁿 [Sébastien Dumont](https://profiles.wordpress.org/sebd86/) Juliol 25, 2023 This is a must have developers tool. Can’t work without it. Highly recommend it. ![](https://secure.gravatar.com/avatar/d3d8d4531d077fe7e52e6d8a0863171468b890e8c854a0978670b0f590728892? s=60&d=retro&r=g) ### 󠀁[Best Plugin For Devs](https://wordpress.org/support/topic/best-plugin-for-devs/)󠁿 [Lukman Nakib](https://profiles.wordpress.org/pyrobd/) Desembre 10, 2022 One of my favourite plugin. Helps a lot with development and debugging. Please keep it update or if we could get a chance to contribute we would love that. ![](https://secure.gravatar.com/avatar/b6bdb2d576c8fee51ad991f796a36379cd645030b0134272e7e758b07d315996? s=60&d=retro&r=g) ### 󠀁[Really worth it !](https://wordpress.org/support/topic/really-worth-it-2/)󠁿 [Hasanuzzaman Shamim](https://profiles.wordpress.org/hasanuzzamanshamim/) Abril 13, 2021 This plugin is amazing, Highly recommended for developers. ![](https://secure.gravatar.com/avatar/07abaee46239545ee77394e297e8ffdeabf63fdc8cd64f185acfeae0a5753685? s=60&d=retro&r=g) ### 󠀁[Absolutely Essential | Makes Me Actually Enjoy Debugging PHP](https://wordpress.org/support/topic/absolutely-essential-makes-me-actually-enjoy-debugging-php/)󠁿 [jaballadares6](https://profiles.wordpress.org/jaballadares6/) Desembre 12, 2019 For so long I have been trying to figure out a way to debug my PHP in WordPress similar to how the JS console works (being able to drill down into objects and arrays). I have no idea how much work Tonya put into this, but I am forever indebted! Thank you so much! I wish i could send you a gift basket or make a donation. ![](https://secure.gravatar.com/avatar/b9053a6f912f05b1e1ea470a81331751af91b7a36a097744070db566332620d2? s=60&d=retro&r=g) ### 󠀁[A must have!](https://wordpress.org/support/topic/a-must-have-351/)󠁿 [digitalfisherman](https://profiles.wordpress.org/digitalfisherman/) Juliol 29, 2019 Can’t live without it ! ![](https://secure.gravatar.com/avatar/15c1b4285844f98bd4a4d24762b3d19d2eb68c66284ca7bd2635434c25476f84? s=60&d=retro&r=g) ### 󠀁[Makes debugging super easy](https://wordpress.org/support/topic/makes-debugging-super-easy/)󠁿 [Jim Ratliff](https://profiles.wordpress.org/jimofhaddonhill/) Juliol 4, 2019 Makes debugging super easy, particularly for people like me—just starting out in WordPress development. Turn it on, and immediately the errors become apparent. [ Read all 13 reviews ](https://wordpress.org/support/plugin/debug-toolkit/reviews/) ## Contributors & Developers “Debug Toolkit” is open source software. The following people have contributed to this plugin. Contributors * [ Tonya Mork ](https://profiles.wordpress.org/hellofromtonya/) [Translate “Debug Toolkit” into your language.](https://translate.wordpress.org/projects/wp-plugins/debug-toolkit) ### Interested in development? [Browse the code](https://plugins.trac.wordpress.org/browser/debug-toolkit/), check out the [SVN repository](https://plugins.svn.wordpress.org/debug-toolkit/), or subscribe to the [development log](https://plugins.trac.wordpress.org/log/debug-toolkit/) by [RSS](https://plugins.trac.wordpress.org/log/debug-toolkit/?limit=100&mode=stop_on_copy&format=rss). ## Changelog #### Version 1.0.1 * Removed changing the admin color palette. * Removed changing the admin bar background color. #### Version 1.0.0 * First release ## Meta * Version **1.0.1** * Last updated **7 anys ago** * Active installations **20+** * WordPress version ** 4.9 or higher ** * Tested up to **5.1.22** * PHP version ** 5.6 or higher ** * Language * [English (US)](https://wordpress.org/plugins/debug-toolkit/) * Tags * [backtrace](https://bal.wordpress.org/plugins/tags/backtrace/)[debug](https://bal.wordpress.org/plugins/tags/debug/) [debugger](https://bal.wordpress.org/plugins/tags/debugger/)[print_r](https://bal.wordpress.org/plugins/tags/print_r/) [var_dump](https://bal.wordpress.org/plugins/tags/var_dump/) * [Advanced View](https://bal.wordpress.org/plugins/debug-toolkit/advanced/) ## Ratings 5 out of 5 stars. * [ 13 5-star reviews ](https://wordpress.org/support/plugin/debug-toolkit/reviews/?filter=5) * [ 0 4-star reviews ](https://wordpress.org/support/plugin/debug-toolkit/reviews/?filter=4) * [ 0 3-star reviews ](https://wordpress.org/support/plugin/debug-toolkit/reviews/?filter=3) * [ 0 2-star reviews ](https://wordpress.org/support/plugin/debug-toolkit/reviews/?filter=2) * [ 0 1-star reviews ](https://wordpress.org/support/plugin/debug-toolkit/reviews/?filter=1) [Add my review](https://wordpress.org/support/plugin/debug-toolkit/reviews/#new-post) [See all reviews](https://wordpress.org/support/plugin/debug-toolkit/reviews/) ## Contributors * [ Tonya Mork ](https://profiles.wordpress.org/hellofromtonya/) ## Support Got something to say? Need help? [View support forum](https://wordpress.org/support/plugin/debug-toolkit/) ## Donate Would you like to support the advancement of this plugin? [ Donate to this plugin ](https://KnowTheCode.io)