WordPress function, class, and global variable declaration stubs for easier static analysis.
Installs: 116 244
Open Issues: 8
- php: ^7.1
- ext-gettext: *
- giacocorsiglia/stubs-generator: ^0.5.0
- johnpbloch/wordpress: 5.1.1
You should use the fork at php-stubs/wordpress-stubs, which is thanks to @szepeviktor.
This package provides stub declarations for WordPress core functions, classes, interfaces, and global variables. These stubs can help plugin and theme developers leverage static analysis tools like Psalm, which often dislike parsing all of WordPress.
The stubs are generated directly from the source using giacocorsiglia/stubs-generator. Needless to say, this library repackages a subset of WordPress code, which is the work of the WordPress core developers. Granted, it's a useless subset without the real thing!
Require this package as a dev-dependency with Composer:
composer require --dev giacocorsiglia/wordpress-stubs
Alternatively, you may download
Usage with Psalm
Update your Psalm config to include the section:
<stubs> <file name="vendor/giacocorsiglia/wordpress-stubs/wordpress-stubs.php" /> </stubs>
Furthermore, ensure WordPress core code is not included under
Usage for Intellisense
If your editor has trouble parsing all of WordPress, you may find the stubs useful for enabling code completion and related features. For example, here are instructions for usage with VSCode's Intelephense extension. (In my experience, however, Intelephense parses WordPress core just fine.)
This package is versioned to match the WordPress version from which the stubs are generated. If any fixes to stubs are required, subsequent releases will be versioned as
Generating stubs for a different WordPress version
You should be running PHP 7.1 or later to follow these steps, so any function definitions that are polyfills for older versions of PHP are excluded from the stubs. Additionally, the Stubs Generator package at least requires PHP 7.1.
- Clone this repository and
composer.jsonwith your desired version.
wordpress-stubs.php file should now be updated. Feel free to submit a Pull Request if you'd like to see a release for a newer version. If things have fallen behind, please generate stubs for each missing version in a distinct commit so we can have a continuous release history.
Please have a look at