Variable Inspector

Contributors: qriouslad
Donate link: https://bowo.io/vi-sp-rdm
Tags: php variables, variable dump, debug, developer
Requires at least: 4.8
Tested up to: 6.2.2
Stable tag: 2.4.3
Requires PHP: 5.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Inspect PHP variables on a central dashboard in wp-admin for convenient debugging.

Description

Variable Inspector allows you to easily inspect your PHP $variables in a visually clean manner at a central dashboard in wp-admin. It aims to be an easy and useful enough dev and debug tool.

It provides a single-line code to inspect your variable (see "How to Use" below). Nothing is shown to site visitors nor being output on the frontend, and the $variable content is nicely formatted for review using var_dump(), var_export() and print_r() on the inspector dashboard in wp-admin.

It's a real time-saver for scenarios where Xdebug or even something like Ray is not ideal or simply an overkill. For example, when coding on a non-local environment via tools like Code Snippets, WPCodeBox, Scripts Organizer or Advanced Scripts. Additionally, because it is a regular WordPress plugin, you simply install, activate and use without the need for complicated configuration.

What Users Say

"Works great! Love this thing." ~Josh

"Every developer need it. You can debug easily every variable." ~Pexle Chris

"All I need. Enough to test the function of snippets. Works flawless." ~@tesig

"It does what it does very well, and doesn't try to do everything." ~@swb1

How to Use

Simply place the following line anywhere in your code after the $variable_name you'd like to inspect:

do_action( 'inspect', [ 'variable_name', $variable_name ] );

If you'd like to record the originating PHP file and line number, append the PHP magic constants __FILE__ and __LINE__ as follows.

do_action( 'inspect', [ 'variable_name', $variable_name, __FILE__, __LINE__ ] );

This would help you locate and clean up the inspector lines once you're done debugging.

Give Back

• A nice review would be great!
• Give feedback and help improve future versions.
• Github repo to contribute code.
• Sponsor my work with as little as USD 1 monthly or one-time.

PRO Version

If you need something more versatile for larger, more complex projects, these PRO features might come in handy:

• vi( $variable ) inspector to replace the do_action() above and automatically includes the file path and line number. Or, use vis( $variable_name, 'variable_name' ) when inspecting in/via code snippets plugins (Code Snippets, WPCodeBox, Scripts Organizer, etc.) or custom code module of page builders (Bricks, Oxygen Builder, etc.)
• dump_print_r and dump_print_tree viewers: both viewers combines var_dump and print_r, with the later allowing for collapsing and expanding data nodes, which is especially useful for inspecting long and complex arrays and objects.
• kint viewer: an advanced viewer with table view for multi-dimensional arrays, node access path info, capability to search inside variables, pop-up window viewing and advanced info for your complex objects, e.g. available methods and static class properties.
• Categorize and filter results by color. This, for example, allows you to categorize $variables according to which stage they're in inside your code.
• Add counter or notes to inspection results. Another way to tag $variables and provide context for the inspection results.
• Search filter: easily find certain $variables by name and type.
• View up to 250 results. The free version is limited to 25 results.
• Individual and bulk deletion of results. Easily clean up your inspection dashboard from obsolete results you no longer need to reference.

Click here to see a screenshot of the PRO version or see below in the screenshots section.

Check These Out Too

• Admin and Site Enhancements helps you to easily enhance various admin workflows and site aspects while replacing multiple plugins doing it.
• System Dashboard: Central dashboard to monitor various WordPress components, processes and data, including the server.
• Debug Log Manager: Log PHP, database and JavaScript errors via WP_DEBUG with one click. Conveniently create, view, filter and clear the debug.log file.
• Code Explorer: Fast directory explorer and file/code viewer with syntax highlighting.
• Flexible Scroll Top and Floating Share Buttons is a lightweight combo with minimalist UI.
• WordPress Newsboard: The latest news, articles, podcasts and videos from 100+ WordPress-focused sources.

Screenshots

1. The variable inspection dashboard
2. The PRO version

Frequently Asked Questions

How was this plugin built?

Variable Inspector was built with: WordPress Plugin Boilerplate | wppb.me | Simple Accordion | Fomantic UI. It was originally inspired by WP Logger.

Changelog

Sponsor Variable Inspector

If this plugin has been useful for your personal project(s), paid dev work, client site(s) and or agency's workflow, please kindly consider sponsoring from as little as USD 1 (monthly or one-time). You can also choose to upgrade to the PRO version. Thank you!

2.4.3 (2023.05.22)

• Add handling for null type / value
• Added link to changelog in footer
• [PRO] Feedback link in header no longer links to wordpress.org support forum. It now links to the contact form within wp-admin.
• [PRO] Fixed: space in vis() inspector's second parameter no longer causes JS error and prevents variable content from loading. This is handled by converting space to underscore, e.g. 'the variable' will show up as $the_variable in the inspection result accordion.
• [PRO] Fixed: special characters inside the 'notes' parameter in vi() and vis() inspectors are now handled better and won't cause JS error.
• [PRO] Fixed: JS error "Maximum call stack size exceeded" when performing ajax actions, e.g. generate sample results, refrehs, etc.
• [PRO] kint viewer: now will properly show $variable_name when getting the access path info of each node in the inspection result
• [PRO] Make the style of NULL results uniform across var_dump_r, var_dump_tree and kint viewers

2.4.0 (2023.05.15)

• [PRO] Added vis() inspector for inspecting $variables via code snippets plugins or custom code modules of page builders
• Remove freemius SDK from free version

2.3.0 (2023.04.24)

• Add identification and labeling of 'float' / 'double' variable type
• Add results counter. Shown next to the 'Results' heading.
• Added modal window for sponsorship
• Launch of PRO version. To find out and/or upgrade, simply click on the green 'Upgrade' button in the inspection dashboard. Lifetime license is available.

2.2.1 (2023.04.16)

• Improve escaping of variables with string type. Preventing inspector layout / HTML output interferrence, especially when the string contains HTML tags.

2.2.0 (2023.04.13)

• Clean up and polish inspector dashboard UI. Remove separator lines.
• Update shortlinks on the dashboard.

2.1.0 (2023.04.11)

• Limit height of each result's content and add scroll bar when content is taller than the limit. This should prevent very long result content from occupying the screen.
• Change background color of each result's content to white for better readability.

2.0.0 (2023.04.10)

• Add button to easily generate sample results. Useful for first-time installation.
• Overall UI/X polish which includes adding loading animation on button clicks, improved auto-refresh UI, improved readability of variable type labels and ensure preferred/chosen viewer is effective/respected after varioius clicks / interaction with the inspection dashboard.
• Change 'Donate' (PayPal) link to (Github) 'Sponsor' link. Do consider sponsoring the continued development of Variable Inspector.
• Add link to WordPress Newsboard in footer, a WordPress news aggregator site I've maintained since 2014.
• Integrate Freemius SDK in preparation for Pro version.

1.9.0 (2023.04.04)

• Move storage of preferred inspection method from wp_options to user meta.

1.8.0 (2022.12.08)

• Fix an issue where sometimes inspection shows empty or false result when result type is array or object.
• Additional suppression of admin notices via all_admin_notices hook and via CSS.

1.7.1 (2022.10.25)

• All admin notices are now suppressed, i.e. no longer shown, on the Variable Inspector page.

1.7.0 (2022.10.11)

• Add viewer (function) selector, e.g. print_r, that will apply to all inspection results after the selection is made and will persist after page reload. The selection is stored in wp_options table. Different viewer can still be selected for each result. Props to @pexlechris for the feedback.

1.6.0 (2022.10.11)

• Add toggle to expand or collapse all inspection results. Props to @pexlechris for the feedback.

1.5.0 (2022.10.09)

• Remove CodeStar framework dependency and replace with lightweight solution
• Dequeue public css and js files as they are empty and unused

1.4.0 (2022.08.18)

• Add Refresh button and "Auto refresh" checkbox to load latest results. Props to @imantsk for the code and suggestion
• Add quick tutorial on the inspector results page to enable users to quickly reference the inspector code

1.3.2 (2022.05.26)

• Confirmed compatibility with WordPress 6.0

1.3.1 (2022.05.19)

• Fixed output via var_export()
• Better sanitization of variable name output
• Update plugin description

1.2.0 (2022.04.14)

• Fixed output buffering mistake causing the output of the '1' character in variable values
• NEW: implement tabbed output of var_export, var_dump and print_r

1.1.0 (2022.04.13)

• Fixed "Fatal error: Uncaught Error: Call to undefined function dbDelta()". Thanks to @rashedul007 for the fix!

1.0.1 (2022.04.13)

• Initial stable release

Upgrade Notice

None required yet.