prereqs.api.php

This file describes the hook(s) available to module developers for the prereqs module.

File

modules/prereqs/prereqs.api.php
View source
  1. <?php
  2. /**
  3. * @file This file describes the hook(s) available to module developers for the prereqs module.
  4. *
  5. */
  6. /**
  7. * If implemented, this hook has the option to modify or add more warnings after the original prereqs function is run.
  8. * @see prereqs_get_prereq_warnings_for_course()
  9. *
  10. *
  11. * Look at prereqs_get_prereq_warnings_for_course() in prereqs.module file as a starting place for implementation.
  12. *
  13. *
  14. */
  15. function hook_prereqs_get_prereq_warnings_for_course(&$warnings, $course, $student = null) {
  16. // Code goes here.
  17. // We do not return anything, since $warnings is passed by reference
  18. }

Functions

Namesort descending Description
hook_prereqs_get_prereq_warnings_for_course If implemented, this hook has the option to modify or add more warnings after the original prereqs function is run.