Admidio Hooks Catalogue

This page documents every hook actually implemented in Admidio 5.1.

Engine: Admidio\Hooks\Hooks (static). Three primitives — Action (addAction/doAction), Filter (addFilter/applyFilters/applyTypedFilters), Resolver (addResolver/resolve).

See the developer documentation how to use the hooks documented here in your own code.

Implemented once in Entity. Every hookable entity dispatches the same nine stages under its own name and under the generic entity_* name. A plugin normally subscribes to the entity-specific name; a cross-cutting plugin (audit, Devhelper) subscribes to the generic one.

The second argument is the live entity, so a callback can read a field the change set does not carry (an unchanged column, a related record) or call a domain method on it — not just observe what changed. It is null for exactly two stages: deleted and delete_failed. Entity::delete() clears the object before either can be dispatched — immediately for a failure outside a transaction, later through the commit/rollback queue for everything else — and a bulk deletion reuses one scratch object for every row it removes, so the object at that point would as often be the wrong record as an empty one. EntityChangeSet::getSnapshot() is what those two describe the record from instead.

Committed (*_created/*_updated/*_deleted) fires after the outermost transaction really commits, never before, and never for a change that is later rolled back. Two saves of the same record in one transaction coalesce into one event. A create+delete of the same never-persisted record fires nothing. *_value runs before Admidio's own type canonicalization, so it sees the proposed input, not the stored form. Bulk-deleted dependent records (Entity::deleteDependentRecords() / hookBulkDeletion()) dispatch the same deleting/deleted pair per record, with EntityChangeSet::isCascade() / getCauseHookId() / getCauseId() naming the record whose deletion caused it.

LogChanges, Text, Preferences, AutoLogin, Session, SSOClient (its subclasses OIDCClient/ SAMLClient are hookable), TokenEntity (OIDC access/refresh tokens, auth codes). Infrastructure, security-sensitive, or too high-frequency to be normal CRUD subjects.

form_select_options's result is enforced: it is the same element definition validate() checks a POST against, so removing an entry there really refuses it server-side.

Both filters and the action fire exactly once per page regardless of how many times show() / getFilteredTitle() / getFilteredHeadline() are called on it. PagePresenter::getHtmlID() gives the stable per-page identifier (adm_<module>[_<view>]) to key behaviour on.

Typed filters — a callback must return a bool, not a truthy value.

No email hook ever receives the Email/PHPMailer object — it carries the SMTP credentials in public properties.

Proven on one module (contacts) with the stable listId contacts; not yet implemented for any other list.

list_columns can relabel a column but not add or remove one: rows are still built by column position, there is no shared list/column pipeline yet, and a count change is refused with an exception rather than silently misaligning every row.

Kept deliberately module-specific: category_report_config is genuine module data with no generic equivalent, and category_report_enabled lets the module tell a direct URL “disabled” apart from “no rights” after component_visible already folds the setting into Component::isVisible().

Hooks::addAction(string $name, callable $callback, int $priority = 10, ?int $acceptedArgs = null, ?string $id = null): void
Hooks::doAction(string $name, mixed ...$args): void
Hooks::doActionCatchErrors(string $name, mixed ...$args): void   // failure/diagnostic dispatch only
 
Hooks::addFilter(string $name, callable $callback, int $priority = 10, ?int $acceptedArgs = null, ?string $id = null): void
Hooks::applyFilters(string $name, mixed $value, mixed ...$args): mixed
Hooks::applyTypedFilters(string $name, mixed $value, mixed ...$args): mixed   // return type must match $value's
 
Hooks::addResolver(string $name, callable $callback, int $priority = 10, ?int $acceptedArgs = null, ?string $id = null): void
Hooks::resolve(string $name, mixed $default = null, mixed ...$args): mixed   // first non-null answer wins
 
Hooks::removeAction(string $name, string|callable $idOrCallback): bool
Hooks::removeFilter(string $name, string|callable $idOrCallback): bool
Hooks::removeResolver(string $name, string|callable $idOrCallback): bool
Hooks::hasAction/hasFilter/hasResolver(string $name): bool
Hooks::reset(string $name = ''): void   // one hook, or the whole registry

Lower priority runs earlier; same priority runs in registration order. A callback throws to veto an Action or a Filter; the exception propagates. doActionCatchErrors() logs and swallows instead, used only at failure/diagnostic sites where the original failure must stay the one Admidio reports.

doAction()/doActionCatchErrors()/applyFilters()/applyTypedFilters()/resolve() are not only for core's own dispatch sites: a module or plugin can call them at its own extension points to make itself extensible by other plugins the same way core is — register the names with add*() as usual, then dispatch them from your own code with these.