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
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
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 any WordPress functions, class methods, parameters, array keys, actions, or filters that are in use were introduced prior to the minimum version of WordPress that your code supports. For example, if your plugin or theme 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() or method_exists() check then an error won't be triggered.
Status
Version information was last updated for WordPress 7.1.
Requirements
- PHPStan 1.x or 2.x
- PHP 7.2 or higher (tested up to PHP 8.5)
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
Themes
If your style.css file contains a "Requires at least" header then wp-compat will read this header and use its value as the minimum supported WordPress version. There is no need for any additional config.
Plugins
If the name of your main plugin file matches its parent directory -- for example my-plugin/my-plugin.php -- then wp-compat will read the "Requires at least" header from this file and use its value as the minimum supported WordPress version. There is no need for any additional config.
If your main plugin file is named otherwise or located elsewhere, you can specify its name in your PHPStan config file:
Manual config
Alternatively you can specify the minimum supported WordPress version number of your plugin or theme directly 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 identifier. For full information, see the PHPStan guide to ignoring errors.
Functions and methods
If your code is correctly guarded with a valid function_exists() or method_exists() check then an error won't be triggered.
Parameters
A parameter which was added to a function or method in a later version of WordPress can be ignored using its error identifier, which contains a sanitized version of the symbol name and the parameter name.
The same applies to the keys of a parameter which accepts an array of arguments. Its error identifier also contains the key, or the dot delimited path to it when the key is nested.
Only keys which PHPStan can determine statically are checked, so an array which is assembled conditionally doesn't trigger an error in the first place.
Actions and filters
There is no concept of checking the existence of an action or filter in WordPress in order to guard its usage. You can still ignore an error for an action or filter using its error identifier, which contains a sanitized version of the hook name.
Technical details
This extension does not scan your project in order to detect the @since versions of WordPress functions, methods, parameters, array keys, and hooks. This information is included directly in the extension. This approach ensures that your code is always tested against the most up to date and most accurate @since documentation, regardless of the version of WordPress that your tests are using.
Functions and methods
The symbols.json file contains a dictionary of all functions, methods, and parameters in WordPress along with the version of WordPress in which they were introduced.
Parameters which accept an array of arguments are documented in WordPress with the hash notation, which means the keys of such a parameter are known too. Any key which was introduced later than the parameter that holds it is recorded alongside it.
The file can be regenerated by running:
The JSON schema for the file can be found in schemas/symbols.json.
Actions and filters
Information about actions and filters is provided by the wp-hooks/wordpress-core package.
Sponsors
The time that I spend maintaining this extension and others is in part sponsored by:
Plus all my kind sponsors on GitHub:
Click here to find out about supporting my open source tools and plugins.
License
MIT
All versions of wp-compat with dependencies
phpstan/phpstan Version ^1.12 || ^2.0
wp-hooks/wordpress-core Version ^1.13