php-stubs/wp-cli-stubs

WP-CLI function and class declaration stubs for static analysis.

Maintainers

Details

github.com/php-stubs/wp-cli-stubs

Homepage

Source

Issues

Installs: 953 903

Dependents: 41

Suggesters: 0

Security: 0

Stars: 25

Watchers: 4

Forks: 2

Open Issues: 4

v2.11.0 2024-11-25 10:09 UTC

Requires

Requires (Dev)

Suggests

MIT f27ff9e8e29d7962cb070e58de70dfaf63183007

wordpressstatic analysiswp-cliPHPStan

This package is auto-updated.

Last update: 2024-12-13 15:52:42 UTC

README

Build Status

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.

Requirements

  • PHP >=7.1

Installation

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.

Usage in PHPStan

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