Download the PHP package johnbillion/wp-compat without Composer
On this page you can find all versions of the php package johnbillion/wp-compat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download johnbillion/wp-compat
More information about johnbillion/wp-compat
Files in johnbillion/wp-compat
Package wp-compat
Short Description PHPStan extension to help verify that your PHP code is compatible with a given version of WordPress
License MIT
Informations about the package wp-compat
WPCompat
WPCompat is a PHPStan extension which helps verify that your PHP code is compatible with a given version of WordPress. You can use it to help ensure that your plugin or theme remains compatible with its "Requires at least" version.
It works by checking that the declared @since
version of any WordPress functions or class methods that are in use is lower than or equal to the minimum version of WordPress that your code supports. For example, if your plugin supports WordPress 6.0 or higher but the get_template_hierarchy()
function is used unconditionally, the extension will trigger an error because that function was only introduced in WordPress 6.1.
If your code is correctly guarded with a valid function_exists()
check then an error won't be triggered. The extension doesn't yet support the same for method_exists()
when calling methods, but it's on the todo list.
Status
WPCompat is a brand new extension and not yet exhaustive in its checks. Version 1.0 will be released once it's stable.
Requirements
- PHPStan 1.12 or higher
- PHP 7.4 or higher (tested up to PHP 8.3)
Installation
If you also install phpstan/extension-installer then you're all set!
Manual installation
If you don't want to use `phpstan/extension-installer`, include extension.neon in your project's PHPStan config:Configuration
Add the minimum supported WordPress version number to the parameters in your PHPStan config file. Note that this must be a string so it must be wrapped in quote marks.
Any version number in major.minor
or major.minor.patch
format is accepted.
Ignoring errors
You can ignore an error from this extension by using its error identifiers. For full information, see the PHPStan guide to ignoring errors.
Technical details
This extension does not scan your project in order to detect the @since
versions of WordPress functions and methods. This information is included in the symbols.json file that's included in the extension.
The symbols.json file contains a dictionary of all functions and methods in WordPress along with the version of WordPress in which they were introduced.
The file can be regenerated by running:
The JSON schema for the file can be found in schemas/symbols.json.
License
MIT