Developers

What does the developer documentation cover?

It documents the public API of our plugins: everything marked @api in the code. Each plugin has its own section with the same structure:

• Guides: how to write a module, add a settings tab, load assets, use the JavaScript API and follow dark mode and color palettes.
• Recipes: short, copyable answers to common jobs, such as a search provider or a list table column.
• Hook reference: every public action and filter with its type, the version it arrived in, its arguments and a starting point.
• Stability: how changes are announced, what is deprecated and which hooks arrived in which version.

Where do you start?

1. Quick start: your first Addofy extension: a small plugin with a module and a notice.
2. Writing a module: the main building block.
3. Hook reference: when you know what you are looking for.

What do you need?

Addofy needs PHP 8.1 or newer and WordPress 6.5 or newer. WooCommerce is optional: the modules for orders, customers and products only load when WooCommerce is active. Your extension should check that Addofy is active before it uses the API, so it keeps working when Addofy is switched off.

Which plugins are documented?

Addofy, the admin that makes WordPress and WooCommerce calm and clear, is the first. More plugins follow with the same structure. For installing plugins and managing licenses, see the plugin documentation.