Skip to content

Add developer lifecycle hooks #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erseco merged 1 commit into from
Jun 2, 2026
Merged

Add developer lifecycle hooks #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,26 @@ Administrators can upload eXeLearning style packages and control which styles th

Uploaded ZIPs are validated against path traversal, absolute paths, oversize archives (default 20 MB, filterable via `exelearning_styles_max_zip_size`), and a strict file-extension allow-list.

## Developer hooks

The plugin exposes a set of WordPress actions and filters (all prefixed with
`exelearning_`) at its main lifecycle boundaries, so you can observe events and
enrich presentation or metadata without modifying the plugin:

- **ELPX extraction** — `exelearning_before_elpx_extract`, `exelearning_after_elpx_extract`
- **Metadata** — `exelearning_elpx_metadata` (filter), `exelearning_after_elpx_metadata_saved`
- **REST save** — `exelearning_before_elpx_save`, `exelearning_after_elpx_save`
- **Shortcode rendering** — `exelearning_shortcode_atts`, `exelearning_preview_url`, `exelearning_shortcode_output` (filters)
- **Styles** — `exelearning_after_style_installed`, `exelearning_after_style_deleted`, `exelearning_after_style_enabled_changed`, `exelearning_style_registry_entry` (filter)
- **Static editor install** — `exelearning_before_editor_install`, `exelearning_after_editor_install`, `exelearning_editor_install_failed`

These hooks are limited to observation and presentation/metadata enrichment: they
cannot bypass validation, capability/nonce checks, path-traversal protection,
checksum verification, or the content-proxy security model.

See [`docs/HOOKS.md`](docs/HOOKS.md) for the full reference, parameters, return
values, and usage examples.

## Development

For development, you can bring up a local WordPress environment with the plugin pre-installed:
Expand Down
Loading