index.rst 854 B

12345678910111213141516171819202122232425262728293031
  1. .. _hooks:
  2. Hooks
  3. =====
  4. In FlaskBB we distinguish from `Python Hooks <#python-hooks>`_ and
  5. `Template Hooks <#template-hooks>`_.
  6. Python Hooks are prefixed with ``flaskbb_`` and called are called in Python
  7. files whereas Template Hooks have to be prefixed with ``flaskbb_tpl_`` and are
  8. executed in the templates.
  9. If you miss a hook, feel free to open a new issue or create a pull
  10. request. The pull request should always contain a entry in this document
  11. with a small example.
  12. A hook needs a hook specification which are defined in
  13. :mod:`flaskbb.plugins.spec`. All hooks have to be prefixed with
  14. ``flaskbb_`` and template hooks with ``flaskbb_tpl_``.
  15. Be sure to also check out the :ref:`api` documentation for interfaces that
  16. interact with these plugins in interesting ways.
  17. .. toctree::
  18. :maxdepth: 1
  19. startup
  20. cli
  21. event
  22. forms
  23. template