Skip to content

Commit

Permalink
Merge branch 'release/v2.3.0' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
qriouslad committed Apr 24, 2023
2 parents 9099904 + 6dcfc5d commit 5966224
Show file tree
Hide file tree
Showing 22 changed files with 641 additions and 91 deletions.
Binary file added .wordpress-org/screenshot-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 49 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Variable Inspector

Contributors: qriouslad
Donate link: https://bowo.io/dotorg-sponsor-vi
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
Stable tag: 2.2.1
Stable tag: 2.3.0
Requires PHP: 5.6
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Expand All @@ -16,12 +16,22 @@ Inspect PHP variables on a central dashboard in wp-admin for convenient debuggin

## 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 debug tool**.
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()](https://www.php.net/manual/en/function.var-dump.php), [var_export()](https://www.php.net/manual/en/function.var-export.php) and [print_r()](https://www.php.net/manual/en/function.print-r.php) on the inspector dashboard in wp-admin.

It's a real time-saver for scenarios where [Xdebug](https://xdebug.org/) or even something like [Ray](https://myray.app/) is not ideal or simply an overkill. For example, when coding on a non-local environment via tools like [Code Snippets](https://wordpress.org/plugins/code-snippets/), [WPCodeBox](https://wpcodebox.com/), [Scripts Organizer](https://dplugins.com/products/scripts-organizer/) or [Advanced Scripts](https://www.cleanplugins.com/products/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](https://wordpress.org/support/topic/works-great-8269/)

_"**Every developer need it.** You can debug easily every variable."_ ~[Pexle Chris](https://wordpress.org/support/topic/awsome-plugin-that-every-developer-need-it/)

_"**All I need**. Enough to test the function of snippets. Works flawless."_ ~[@tesig](https://wordpress.org/support/topic/all-i-need-39/)

_"**It does what it does very well**, and doesn't try to do everything."_ ~[@swb1](https://wordpress.org/support/topic/exactly-what-i-needed-868/)

### How to Use

Simply place the following line anywhere in your code after the `$variable_name` you'd like to inspect:
Expand All @@ -36,10 +46,27 @@ This would help you locate and clean up the inspector lines once you're done deb

### Give Back

* [A nice review](https://bowo.io/add-review-vi) would be great!
* [Give feedback](https://bowo.io/feedback-vi) and help improve future versions.
* [Github repo](https://bowo.io/github-vi) to contribute code.
* [Sponsor](https://bowo.io/dotorg-sponsor-vi) my work.
* [A nice review](https://bowo.io/vi-rvw-dsc) would be great!
* [Give feedback](https://bowo.io/vi-fdbk-dsc) and help improve future versions.
* [Github repo](https://bowo.io/vi-gthb-dsc) to contribute code.
* Sponsor my work with as little as USD 1 [monthly](https://bowo.io/vi-sp-gth-rdm) or [one-time](https://bowo.io/vi-sp-ppl-rdm).

### 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.
- **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.

See a screenshot of the PRO version below in the screenshots section.

To upgrade, simply go to Variable Inspector dashboard in wp-admin and hit the Upgrade button. Or, go to this [hosted page](https://bowo.io/vi-up-hstd-dsc).

### Check These Out Too

Expand All @@ -48,21 +75,34 @@ This would help you locate and clean up the inspector lines once you're done deb
* [Debug Log Manager](https://wordpress.org/plugins/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](https://wordpress.org/plugins/code-explorer/): Fast directory explorer and file/code viewer with syntax highlighting.
* [Flexible Scroll Top](https://wordpress.org/plugins/flexible-scroll-top/) and [Floating Share Buttons](https://wordpress.org/plugins/floating-share-button/) is a lightweight combo with minimalist UI.
* [WordPress Newsboard](https://www.wpnewsboard.com/): The latest news, articles, podcasts and videos from 100+ WordPress-focused sources.
* [WordPress Newsboard](https://bowo.io/vi-wpn-dsc): The latest news, articles, podcasts and videos from 100+ WordPress-focused sources.

## Screenshots

1. The variable inspection dashboard
![The variable inspection dashboard](.wordpress-org/screenshot-1.png)
2. The PRO version
![The PRO version](.wordpress-org/screenshot-2.png)

## Frequently Asked Questions

### How was this plugin built?

Variable Inspector was built with: [WordPress Plugin Boilerplate](https://github.com/devinvinson/WordPress-Plugin-Boilerplate/) | [wppb.me](https://wppb.me/) | [CodeStar framework](https://github.com/Codestar/codestar-framework) | [Simple Accordion](https://codepen.io/gecugamo/pen/xGLyXe) | [Fomantic UI](https://fomantic-ui.com/). It was originally inspired by [WP Logger](https://wordpress.org/plugins/wp-data-logger/).
Variable Inspector was built with: [WordPress Plugin Boilerplate](https://github.com/devinvinson/WordPress-Plugin-Boilerplate/) | [wppb.me](https://wppb.me/) | [Simple Accordion](https://codepen.io/gecugamo/pen/xGLyXe) | [Fomantic UI](https://fomantic-ui.com/). It was originally inspired by [WP Logger](https://wordpress.org/plugins/wp-data-logger/).

## Changelog

### Sponsor Admin and Site Enhancements

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](https://bowo.io/vi-sp-gth-chnlg) or [one-time](https://bowo.io/vi-sp-ppl-chnlg)). This helps ensure you're going to continue seeing **new features and/or fixes**, hopefully for years to come. Thank you!

### 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.
Expand Down
Loading

0 comments on commit 5966224

Please sign in to comment.