php-stubs/woocommerce-stubs

WooCommerce function and class declaration stubs for static analysis.

v9.5.0 2024-12-17 03:31 UTC

Requires

• php-stubs/wordpress-stubs: ^5.3 || ^6.0

Requires (Dev)

• php: ~7.1 || ~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
• woocommerce
• PHPStan

README

Important

Hello everyone! This is Viktor who runs the php-stubs organization. I am planning to stop contributing to the WordPress ecosystem because it is extremely difficult and I do not earn (min) €100/month.

Please support my work to avoid abandoning this package.

Thank you!

WooCommerce Stubs

This package provides stub declarations for the WooCommerce plugin functions, classes and interfaces. These stubs can help plugin and theme developers leverage IDE completion and static analysis tools like PHPStan.

The stubs are generated directly from the source using php-stubs/generator.

Requirements

• PHP >=7.1

Installation

Require this package as a development dependency with Composer.

composer require --dev php-stubs/woocommerce-stubs

Alternatively you may download woocommerce-stubs.php directly.

Usage in PHPStan

Include stubs in PHPStan configuration file.

parameters:
    bootstrapFiles:
        - vendor/php-stubs/woocommerce-stubs/woocommerce-stubs.php
        #- vendor/php-stubs/woocommerce-stubs/woocommerce-packages-stubs.php

Support package maintenance

Please consider supporting this work.

Thank you!