This package is a fork of giacocorsiglia/stubs-generator
.
It provides stub declarations for WordPress
core functions, classes and interfaces, globals are not included.
These stubs can help plugin and theme developers leverage static analysis tools
like PHPStan,
which is not able to parse WordPress as it is not OOP code.
The stubs are generated directly from the source using giacocorsiglia/stubs-generator.
- PHP >=7.1
- Sodium PHP extension as latest WordPress core uses it and compat code is removed from stubs,
Sodium is included in PHP from version 7.2, in 7.1 issue
pecl install libsodium
or install theparagonie/sodium_compat
package - For PHP <7.3 install the
symfony/polyfill-php73
as development dependency
Require this package as a development dependency with Composer.
composer require --dev php-stubs/wordpress-stubs
Alternatively you may download wordpress-stubs.php
directly.
composer require --dev szepeviktor/phpstan-wordpress
The package szepeviktor/phpstan-wordpress
depends on phpstan/phpstan
and this one.
Please do read
that package's README
and see the example
directory over there.
Update your Psalm config to include this section.
<stubs>
<file name="vendor/php-stubs/wordpress-stubs/wordpress-stubs.php" />
</stubs>
Furthermore ensure WordPress core is not included in <projectFiles>
.
If your IDE has trouble parsing all of WordPress you may find the stubs useful for enabling code completion and related features. For example there are instructions for usage with VSCode's Intelephense extension.
This package is versioned to match the WordPress version from which the stubs are generated.
- Run modern PHP version
- Clone this repository and
cd
into it - Update
"johnpbloch/wordpress": "x.x.x"
incomposer.json
with the desired version - Run
composer update
- And run
./generate.sh
The wordpress-stubs.php
file should now be updated.