|Number of watchers on Github||143|
|Number of open issues||113|
|Average time to close an issue||3 months|
|Average time to merge a PR||18 days|
|Open pull requests||13+|
|Closed pull requests||11+|
|Last commit||over 2 years ago|
|Repo Created||almost 8 years ago|
|Repo Last Updated||over 1 year ago|
|Organization / Author||automattic|
|Do you use vip-scanner? Leave a review!|
|View open issues (113)|
|View vip-scanner activity|
|View on github|
|Fresh, new opensource launches 🚀🚀🚀|
Trendy new open source projects in your inbox! View examples
A WordPress plugin that enables you to scan all sorts of themes and files and things.
Requires WordPress version 3.4 or greater and PHP >= 5.4.
The plugin itself is simply a UI for the VIP Scanner library, which does all the heavy lifting. The library allows you to create arbitrary
Checks (e.g. UndefinedFunctionCheck), group them together as Reviews (e.g. WP.com Theme Review), and run them against themes, plugins, directories, single files, and even diffs.
For parsing PHP files, VIP Scanner uses PHP-Parser,
which it includes as a git submodule. When cloning VIP Scanner's git repo, use
--recursive parameter to include PHP-Parser, i.e.
git clone --recursive firstname.lastname@example.org:Automattic/vip-scanner.git
If you have already cloned the repo without the
--recursive parameter and
find yourself with an empty
vendor/PHP-Parser directory, run
git submodule update --init --recursive.
Install using the Plugin Installer.
You can find the tool under Tools > VIP Scanner. There, you can choose what
type of scan you'd like to perform -- there's a dropdown list on the right hand
side, just next to the
The dropdown allows you to choose between three types of scan:
Once you have selected a scan type, you can hit the
Scan button and see the
results in the tabbed view below.
If you prefer to use the wp-cli tool for your check, there's a
command with two main actions:
$ wp vip-scanner usage: wp vip-scanner analyze-theme [--theme=<theme>] [--scan_type=<scan-type>] [--depth=<depth>] or: wp vip-scanner scan-theme [--theme=<theme>] [--scan_type=<scan_type>] [--summary] [--format=<format>]
--themeis the theme's path relative to the WP themes directory, for example,
pub/twentyfourteen. Defaults to the current theme.
--scan_typeexpects one of the following options:
"Undefined Function Check",
"WP.com Theme Review"or
"VIP Theme Review". Defaults to
VIP Theme Review.
--depthexpects an integer. You can change the parameter to indicate how many levels of hierarchy you would like outputted. 0 outputs everything. Defaults to 1.
--summarygives you just an overview of how many files were checked, how many checks were done and how many errors, warnings and blockers were found.
--formatallows you to select a output format:
CSV. Defaults to
pre_option_*to also include
scan_typeargument is now optional
wp vip-scanner analyze-theme