Provides stub declarations for WPGraphQL core functions, classes and interfaces. These stubs can help plugin and theme developers leverage static analysis tools like PHPStan.
The stubs are generated with php-stubs/generator.
- PHP 7.3+
- Sodium PHP extension as latest WordPress core uses it and compat code is removed from stubs.
Require this package as a development dependency with Composer.
composer require --dev axepress/wp-graphql-stubsAlternatively you may download wp-graphql-stubs.php directly.
composer require --dev phpstan/phpstan szepeviktor/phpstan-wordpress axepress/wp-graphql-stubsThe package szepeviktor/phpstan-wordpress
depends on phpstan/phpstan.
Please do read
that package's README
and see the example directory over there.
This package is versioned to match the WPGraphQL version from which the stubs are generated.
When changes are made to the actual stub generation that require a new release, the old release is deleted and a new tag is created with the format x.x.x+repack.y where x.x.x is the WPGraphQL version and y is the the repack iteration. This is necessary because Composer's SemVer implementation ignores build meta when determining the latest version.
If you already have an old build of the version installed, you will need to run composer update --no-cache to get the latest repack.
- Clone this repository and
cdinto it. - Update
"wpackagist-plugin/wp-graphql": "x.x.x"incomposer.jsonwith the desired version - Run
composer update - Run
composer generate
The wp-graphql-stubs.php file should now be updated.
- Based on php-stubs/woocommerce-stubs.
- Inspired by the original wp-graphql-stubs project.