christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-15 09:44:07 +00:00
Code Issues Releases Activity
aac0355183
tutor/docs/reference/api/hooks/catalog.rst

19 lines
543 B
ReStructuredText
Raw Normal View History

feat: refactor hooks API for simplification The hooks API had several issues which are summarized in this comment: https://github.com/openedx/wg-developer-experience/issues/125#issuecomment-1313553526 1. "consts" was a bad name 2. "hooks.filters" and "hooks.Filters" could easily be confused 3. docs made it difficult to understand that plugin developers should use the catalog To address these issues, we: 1. move "consts.py" to "catalog.py" 2. Remove "hooks.actions", "hooks.filters", "hooks.contexts" from the API. 3. re-organize the docs and give better usage examples in the catalog. This change is a partial fix for https://github.com/openedx/wg-developer-experience/issues/125
2023-01-06 18:02:17 +00:00
.. _hooks_catalog:
=============
Hooks catalog
=============
Tutor can be extended by making use of "hooks". Hooks are either "actions" or "filters". Here, we list all instances of actions and filters that are used across Tutor. Plugin developers can leverage these hooks to modify the behaviour of Tutor.
The underlying Python hook classes and API are documented :ref:`here <hooks_api>`.
.. autoclass:: tutor.hooks.Actions
:members:
.. autoclass:: tutor.hooks.Filters
:members:
.. autoclass:: tutor.hooks.Contexts
:members:
Copy Permalink