forked from wpengine/phpcompat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
executable file
·208 lines (138 loc) · 9.46 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
=== PHP Compatibility Checker ===
Contributors: wpengine, octalmage, stevenkword, Taylor4484, pross, jcross
Tags: php 7, php 5.5, php, version, compatibility, checker, wp engine, wpe, wpengine
Requires at least: 3.5
Tested up to: 4.9
Stable tag: 1.4.6
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.
== Description ==
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 code-paths that might be used for backwards compatibility, and thus might show false positives. We maintain a [whitelist of plugins](https://github.com/wpengine/phpcompat/wiki/Results) that can cause false positives. We are continuously working to ensure the checker provides the most accurate results possible.**
**This plugin relies on WP-Cron to scan files in the background. The scan will get stuck if the site's WP-Cron isn't running correctly. Please see the [FAQ](https://wordpress.org/plugins/php-compatibility-checker/faq/) for more information.**
= Update to PHP 7.2 =
* Use this plugin to check your site for compatibility up to PHP 7.2!
* As of [November 2016](https://wordpress.org/about/stats/), 52.9% 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 3.4% of WordPress websites run PHP 7, the current main version of PHP.
= Disclaimer =
*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](https://github.com/wpengine/phpcompat) 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 [email protected]
== Installation ==
*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:
1. Upload `phpcompat` to the `/wpengine-wp-content/plugins/` directory
2. 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](https://wordpress.org/plugins/php-compatibility-checker/other_notes/) tab for details.
== Other Notes ==
PHP Compatibility Checker includes WP-CLI command support:
`wp phpcompat <version> [--scan=<scan>]`
`
<version>
PHP version to test.
[--scan=<scan>]
Whether to scan only active plugins and themes or all of them.
default: active
options:
- active
- all
`
Example: `wp phpcompat 7.2 --scan=active`
== Frequently Asked Questions ==
1. Will this work outside of the WP Engine hosting account?
Yes, this plugin can be used any ANY WordPress website on ANY host.
2. Are there WP-CLI commands available?
Yes, this plugin does extend WP-CLI and provide commands. See the [Other Notes](https://wordpress.org/plugins/php-compatibility-checker/other_notes/) tab for details.
3. A plugin I created is listed as not compatible, what should I do?
We maintain a [whitelist of plugins](https://github.com/wpengine/phpcompat/wiki/Results) that cause false positives. If your plugin shows up as incompatible but you think that is wrong, please open a [GitHub issue](https://github.com/wpengine/phpcompat/issues/new) on the project, or email [email protected] with info about your plugin and why you know it is compatible (you have automated tests, the failure is on backwards compatibility code paths, etc).
4. 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](https://github.com/wimg/PHPCompatibility) that this plugin is built on.
5. 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](https://make.wordpress.org/core/handbook/tutorials/installing-a-local-server/) of your site, or you can use the WP-CLI command.
You can use the filter `wpephpcompat_scan_timeout` to customize the scan timeout. See [this](https://gist.github.com/octalmage/07f26e0d1f25cea9a8ca92ebc67a3a14) for an example.
Setting the timeout to 0 disables the cron/timeout.
6. The scan is stuck, what can I do?
The PHP Compatibility Checker relies on WP-Cron to process plugins/themes in batches, this is necessary to avoid server timeouts. The scan will get stuck if your site's WP-Cron isn't functioning. You can look into this using [WP Crontrol](https://wordpress.org/plugins/wp-crontrol/). The cron is called `wpephpcompat_start_test_cron`. This could also be an issue if your site is using basic authentication.
You can also use the [WP-CLI command](https://wordpress.org/plugins/php-compatibility-checker/other_notes/) or disable the timeout to avoid using WP-Cron.
7. 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](https://github.com/wpengine/phpcompat). 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 [email protected]
== Screenshots ==
1. Main screen: compatibility checker options
2. Compatibility results screen
== Changelog ==
= 1.4.6 =
- Switched to new PHPCompatibilityWP library to help prevent false positives.
= 1.4.5 =
- Use plugin version number to enqueue scripts and styles.
= 1.4.4 =
- PHP 5.2 Support & PHP 7.1 and 7.2 Lints.
- Updated call to action sidebar depending on platform.
= 1.4.3 =
- Fixed Composer issue.
= 1.4.1 =
- Updated PHP_CodeSniffer to fix a security advisory.
- Whitelisted a number of plugins.
= 1.4.0 =
- Updated UX for viewing PHP errors to be more intuitive and require less scrolling.
- Added links for non-technical users who need assistance from developers to fix PHP errors or to test their site in PHP 7 enabled hosting environments.
= 1.3.2 =
- Added a "Clean up" button and uninstall.php.
- Added phpcompat_phpversions filter.
= 1.3.1 =
- Whitelisted a number of plugins.
= 1.3.0 =
- Updated the PHPCompatibility library to latest version. Should fix many false positives.
- Changed language and added help text to Admin UI.
= 1.2.4 =
- Fixed Composer issue.
= 1.2.3 =
- Updated the PHPCompatibility library to latest version.
- Whitelisted TablePress.
= 1.2.2 =
- Whitelisted UpdraftPlus and Max Mega Menu.
= 1.2.1 =
- Updated the PHPCompatibility library to latest version
= 1.2.0 =
- Updated the PHPCompatibility library to latest version
- Added support for PHP 5.6
= 1.1.2 =
- Fixed issue with WordPress notices breaking the plugin header.
- Changed the way we send and parse JSON.
- You can now restart an in progress scan.
- Updated download.js to v4.2 for better Safari compatibility.
= 1.1.1 =
- Fixed bug with active job display.
- Updated progress bar calculation.
= 1.1.0 =
- 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.
= 1.0.3 =
- Fixed a bug in the WP-CLI command
- Added a handful of PHP 7 compatible plugins to the whitelist
= 1.0.2 =
- 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
= 1.0.1 =
- Updated compatibility library with a few bugfixes
- Added skip logic to prevent checker from hanging
= 1.0.0 =
- 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
= 0.1.0 =
- Initial version
- PHP 5.5, 5.4, and 5.3 Support
- Basic WP-CLI Commands
== Upgrade Notice ==
= 1.4.6 =
- Switched to new PHPCompatibilityWP library to help prevent false positives.