Skip to main content

Hook Documentation Overview

MentorKit LMS exposes custom WordPress action and filter hooks for extension code. These developer pages are generated from docs-lms/hook-metadata.json, with docs-lms/hook-inventory.md kept as the broader source/reference inventory.

This section documents MentorKit-owned hooks only: scorm_*, mentorkit_*, and mk_security_*. Classic WordPress, WooCommerce, Polylang, Astra, admin, enqueue, AJAX, post type, and template hooks are not treated as MentorKit APIs here.

Actions and Filters​

  • Actions run at a point in MentorKit execution. Use add_action() when your integration needs to perform work, render additional markup, or react to an event.
  • Filters receive a value and must return a value. Use add_filter() when your integration needs to adjust query arguments, labels, URLs, payloads, settings, classes, or other values before MentorKit uses them.

Stability Labels​

  • Public: documented custom MentorKit hooks intended for developer integrations. Current count: 138.
  • Pro integration: hooks used by MentorKit Pro or add-on code. They are documented, but their usefulness can depend on the related Pro module being active. Current count: 9.
  • Internal and scheduled event: kept in the inventory/metadata but not promoted in public hook pages. Current counts: 7 internal, 5 scheduled event.

Using Examples​

Examples in these pages are conservative no-op scaffolds. They use the callback parameters exposed by the source hook and either perform a placeholder action or return the original filtered value. Replace only the callback body you need, keep return types compatible with the source default, and avoid assuming undocumented behavior from a hook name alone.

Reference Artifacts​