Hook And Filter Reference
Hook And Filter Reference
This reference documents Alpaca’s public PHP hooks, JavaScript extension points, and browser-side extension APIs.
Scope
- Includes the main
alpacaplugin only. - Includes dynamic REST action names created with
do_action( 'alpaca_rest_' . $action_type, ... )anddo_action( 'alpaca_rest_error_' . $action_type, ... ). - Includes JavaScript
wp.hooksextension points and the publicwindow.alpaca.itemDatapointsbrowser API exposed by the React application.
How To Use This Reference
Each PHP or JavaScript hook entry includes:
- The hook type (
actionorfilter). - A purpose statement focused on runtime behavior.
- The parameter list in call order.
- A source reference with the current file path and line number or line range.
To refresh the PHP and JavaScript source file line references after code moves, run npm run docs:refresh-hook-lines from the plugin root.
Use the pages below when you need exact signatures, examples, source locations, or subsystem-level navigation.
Reference Pages
| Page | Focus | Entries |
|---|---|---|
| core-and-admin.md | Initialization, permissions, board behavior, admin UI, localization, migrations | 7 |
| notifications.md | Notification channels, recipients, routing, message delivery, mail sender hooks | 14 |
| daily-digest.md | Daily digest payload building, rendering, and channel dispatch | 8 |
| rest-api.md | REST response hooks, dynamic REST hooks, and REST root customization | 5 |
| private-comments.md | Private comment visibility and REST override hooks | 2 |
| javascript-filters.md | JavaScript filters and the public card datapoint browser API | 26 |
| javascript-actions.md | JavaScript actions emitted by issue, comment, watchlist, and datapoint workflows | 35 |