WordPress plugin for Psalm
[](https://packagist.org/packages/humanmade/psalm-plugin-wordpress)
[](https://packagist.org/packages/humanmade/psalm-plugin-wordpress)
Write type-safe WordPress code.
This [Psalm](https://psalm.dev/) plugin provides all WordPress and WP CLI stubs, so your WordPress based project or plugin will have type information for calls to WordPress APIs. This ensures your WordPress plugin or theme has less bugs!
- [x] Stubs for all of WordPress Core
- [x] Stubs for WP CLI
- [x] Types for `apply_filters` return values.
- [x] Types for `add_filter` / `add_action`
- [x] Configuration options to use your own stubs
## Installation
Please refer to the [full Psalm documentation](https://psalm.dev/quickstart) for a more detailed guide on introducing Psalm into your project.
After Psalm is installed, install this package and enable the plugin:
```shell
composer require --dev humanmade/psalm-plugin-wordpress
./vendor/bin/psalm-plugin enable humanmade/psalm-plugin-wordpress
```
## Configuration
If you follow the installation instructions, the `psalm-plugin` command will add this plugin configuration to the `psalm.xml` configuration file.
```xml
```
If you do not want to use the default WordPress stubs, which are part of this plugin, `useDefaultStubs` must be set to `false`:
```xml
```
If you do not want to use the default WordPress hooks, which are part of this plugin, `useDefaultHooks` must be set to `false`:
```xml
```
You can also provide custom hooks:
```xml
```
Further details about plugins can be found on [Psalm's website](https://psalm.dev/docs/running_psalm/plugins/using_plugins/).
## Interested in contributing?
Feel free to open a PR to fix bugs or add features!
In addition, have a look at Psalm's [contribution guidelines](https://github.com/vimeo/psalm/blob/master/CONTRIBUTING.md).
## Who made this
Created by @joehoyle, maintained by the Psalm community.