Payload comes with a built-in Plugins infrastructure that allows developers to build their own modular and easily reusable sets of functionality.
Writing plugins is no more complex than writing regular JavaScript. If you know how spread syntax works and are up to speed with Payload concepts, writing a plugin will be a breeze.
Example use cases:
upload
-enabled collections with a third-party file host like S3 or CloudinaryThe base Payload config allows for a plugins
property which takes an array
of Plugins
.
Payload Plugins are executed after the incoming config is validated, but before it is sanitized and had default options merged in.
After all plugins are executed, the full config with all plugins will be sanitized.
Here is an example for how to automatically add a lastModifiedBy
field to all Payload collections using a Plugin written in TypeScript.
You can discover existing plugins by browsing the payload-plugin
topic on GitHub.
For maintainers building plugins for others to use, please add the topic to help others find it. If you would like one to be built by the core Payload team, open a Feature Request in our GitHub Discussions board. We would be happy to review your code and maybe feature you and your plugin where appropriate.