Contributors: wpengine, octalmage, stevenkword, taylor4484
Tags: php 7, php 5.5, php, version, compatibility, checker, wp engine, wpe, wpengine
Requires at least: 3.0.1
Tested up to: 4.5
Stable tag: 1.1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Make sure your plugins and themes are compatible with newer PHP versions.
The WP Engine PHP Compatibility Checker can be used by any WordPress website on any web host to check PHP version compatibility.
This plugin will lint theme and plugin code inside your WordPress file system and give you back a report of compatibility issues for you to fix. Compatibility issues are categorized into errors and warnings and will list the file and line number of the offending code, as well as the info about why that line of code is incompatible with the chosen version of PHP. The plugin will also suggest updates to themes and plugins, as a new version may offer compatible code.
This plugin does not execute your theme and plugin code, as such this plugin cannot detect runtime compatibility issues.
Please note that linting code is not perfect. This plugin cannot detect unused codepaths that might be used for backwards compatibility, and thus might show false postiives. We maintain a whitelist of plugins that can cause false positives. We are continuously working to ensure the checker provides the most accurate results possible.
- Use this plugin to check your site for compatibility for PHP 7!
- As of July 2016, 59.3% of WordPress websites run a PHP version less PHP 5.5.
- These versions of PHP have been deprecated and unsupported for over 9 months.
- Only 1.8% of WordPress websites run PHP 7, the current main version of PHP.
While this plugin is written to detect as many problems as accurately as possible, 100% reliable detection is very difficult to ensure. It is best practice to run comprehensive tests before you migrate to a new PHP version.
The plugin was created by WP Engine to help the WordPress community increase adoption of modern PHP versions. We welcome contributors to this plugin, and are excited to see how developers and other WordPress hosts use this plugin.
To disclose security issues for this plugin please email WordPress@wpengine.com
Note: If you have WordPress 2.7 or above you can simply go to 'Plugins' > 'Add New' in the WordPress admin and search for "PHP Compatibility Checker" and install it from there.
To manually install:
- Upload
phpcompatto the/wpengine-wp-content/plugins/directory - Activate the plugin through the 'Plugins' menu in WordPress
You will find the plugin options in the WP Admin Tools => PHP Compatibility menu. Once you click run it will take a few minutes to conduct the test. Feel free to navigate away from the page and check back later.
There are WP-CLI commands available see the Other Notes tab for details.
PHP Compatibility Checker includes WP-CLI command support:
wp phpcompat <version> [--scan=<scan>]
`
PHP version to test.
[--scan=]
Whether to scan only active plugins and themes or all of them.
default: active
options:
- active
- all
Example:wp phpcompat 5.5 --scan=active`
-
Will this work outside of the WP Engine hosting account?
Yes, this plugin can be used any ANY WordPress website on ANY host.
-
Are there WP-CLI commands available?
Yes, this plugin does extend WP-CLI and provide commands. See the Other Notes tab for details.
-
A plugin I created is listed as not compatible, what should I do?
We maintain a whitelist of plugins that cause false positives. If your plugin shows up as incompatible but you think that is wrong, please open a GitHub issue on the project, or email wordpress@wpengine.com with info about your plugin and why you know it is compatible (you have automated tests, the failure is on backwards compatibility codepaths, etc).
-
Can I use this to test non-WordPress PHP Projects?
Yes! While you cannot use this WordPress plugin to test your non-WordPress projects, you can use the Open Source PHPCompatibility Library that this plugin is built on.
-
Why was my plugin/theme skipped?
Some servers have timeouts to prevent long running queries, this is commonly 60 seconds. This can prevent the checker from being able to process large themes or plugins. You should check with your host to see if this timeout can be temporarily removed. The best way around this timeout issue is to run this plugin on a local copy of your site, or you can use the WP-CLI command.
You can use the filter
wpephpcompat_scan_timeoutto customize the scan timeout. See this for an example.Setting the timeout to 0 disables the cron/timeout.
-
I found a bug, or have a suggestion, can I contribute back?
Yes! WP Engine has a public GitHub repo where you can contribute back to this plugin. Please open an issue on the Plugin GitHub. We actively develop this plugin, and are always happy to receive pull requests.
The plugin was created by WP Engine to help the WordPress community increase adoption of modern PHP versions. We welcome contributors to this plugin, and are excited to see how developers and other WordPress hosts use this plugin.
To disclose security issues for this plugin please email WordPress@wpengine.com
- Test results now persist page reloads.
- Failed tests will show an overview of the results.
- The scan timeout is now configurable using a filter. See the FAQ for more details.
- Fixed a bug in the WP-CLI command
- Added a handful of PHP 7 compatible plugins to the whitelist
- Added additional role protections
- Changed the UI colors to better understand output at a glance
- Exclude checking node_modules and tmp directories
- Added support for child theme's parent theme
- Updated compatibility library with a few bugfixes
- Added skip logic to prevent checker from hanging
- Major update to add PHP 7 checking support
- Improved the UX of the progress bar
- Fixed bug with the way the plugin menu was registered
- Initial version
- PHP 5.5, 5.4, and 5.3 Support
- Basic WP-CLI Commands
- Test results now persist page reloads.
- Failed tests will show an overview of the results.
- The scan timeout is now configurable using a filter. See the FAQ for more details.