php-stubs/wordpress-tests-stubs

WordPress Tests function and class declaration stubs for static analysis.

v6.5.0 2024-04-02 18:38 UTC

Requires (Dev)

• php: ~7.3 || ~8.0
• php-stubs/generator: ^0.8.0

Suggests

• symfony/polyfill-php73: Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
• szepeviktor/phpstan-wordpress: WordPress extensions for PHPStan

MIT

• wordpress
• static analysis
• PHPStan

README

This package provides stub declarations for the WordPress Core Test Suite functions, classes and interfaces.

These stubs can help plugin and theme developers leverage static analysis tools like PHPStan, when writing tests for WordPress plugins, themes, and core.

Stubs are generated directly from the source using giacocorsiglia/stubs-generator.

Requirements

• PHP >=7.3

Installation

Require this package as a development dependency with Composer.

composer require --dev php-stubs/wordpress-tests-stubs

Alternatively you may download wordpress-tests-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/wordpress-tests-stubs/wordpress-tests-stubs.php