customize_develop.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. Developing your website
  2. =======================
  3. Page models
  4. -------------
  5. The django app ``website`` has been created with default models based on pre-built abstract
  6. CodeRed CMS models. You can use these as-is, override existing fields and function, and add
  7. custom fields to these models. After making a change to any of these models, be sure to run
  8. ``python manage.py makemigrations website`` and ``python manage.py migrate`` to apply the
  9. database changes.
  10. Hooks
  11. -----
  12. Building on the concept of wagtail hooks, there are some additional hooks in CodeRed CMS
  13. is_request_cacheable
  14. ^^^^^^^^^^^^^^^^^^^^
  15. This hook is provided by `wagtail-cache <https://github.com/coderedcorp/wagtail-cache>`_.
  16. The callable passed into this hook should take a ``request`` argument, and return a ``bool``
  17. indicating whether or not the response to this request should be cached (served from the cache
  18. if it is already cached). Not returning, or returning anything other than a bool will not
  19. affect the caching decision. For example::
  20. from wagtail.core import hooks
  21. @hooks.register('is_request_cacheable')
  22. def nocache_in_query(request, curr_cache_decision):
  23. # if the querystring contains a "nocache" key, return False to forcibly not cache.
  24. # otherwise, do not return to let the CMS decide how to cache.
  25. if 'nocache' in request.GET:
  26. return False