Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/enrol/manual/ -> externallib.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

External course participation api. This api is mostly read only, the actual enrol and unenrol support is in each enrol plugin.

Copyright: 2011 Jerome Mouneyrac
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 228 lines (9 kb)
Included or required:0 times
Referenced: 3 times
Includes or requires: 0 files

Defines 1 class

enrol_manual_external:: (6 methods):
  enrol_users_parameters()
  enrol_users()
  enrol_users_returns()
  unenrol_users_parameters()
  unenrol_users()
  unenrol_users_returns()


Class: enrol_manual_external  - X-Ref

Manual enrolment external functions.

enrol_users_parameters()   X-Ref
Returns description of method parameters.

return: external_function_parameters

enrol_users($enrolments)   X-Ref
Enrolment of users.

Function throw an exception at the first error encountered.
param: array $enrolments  An array of user enrolment

enrol_users_returns()   X-Ref
Returns description of method result value.

return: null

unenrol_users_parameters()   X-Ref
Returns description of method parameters.

return: external_function_parameters

unenrol_users($enrolments)   X-Ref
Unenrolment of users.

param: array $enrolments an array of course user and role ids

unenrol_users_returns()   X-Ref
Returns description of method result value.

return: null