This package provides stub declarations for WP-CLI functions, classes and interfaces. These stubs can help plugin and theme developers leverage static analysis tools like PHPStan, which are unable to parse WP-CLI as it is not clean OOP code.
Stubs are generated directly from the source using giacocorsiglia/stubs-generator.
- PHP >=7.1
Require this package as a development dependency with Composer.
composer require --dev php-stubs/wp-cli-stubs
Alternatively you may download wp-cli-stubs.php
directly.
Include all stubs in PHPStan configuration file.
parameters:
scanFiles:
- %rootDir%/../../php-stubs/wordpress-stubs/wordpress-stubs.php
- %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-stubs.php
- %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-commands-stubs.php
- %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-i18n-stubs.php
- %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-tools-stubs.php