Moodle 3.9 XRef and Diffs

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

Get all of the allowed types for all of the courses and groups
the logged in user belongs to.

The returned array will optionally have 5 keys:
'user' : true if the logged in user can create user events
'site' : true if the logged in user can create site events
'category' : array of course categories that the user can create events for
'course' : array of courses that the user can create events for
'group': array of groups that the user can create events for
'groupcourses' : array of courses that the groups belong to (can
be different from the list in 'course'.
return: array The array of allowed types.

Gets array of all groups in a set of course.

param: array $courses Array of course objects or course ids.
return: array Array of groups indexed by course id.

Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists
param: stdClass $qhandler A row from the events_queued_handler table

Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise

get_roles_on_exact_context(context $context) X-Ref

This function finds the roles assigned directly to this context only
i.e. no roles in parent contexts

param: context $context
return: array

get_roles_with_assignment_on_context(context $context) X-Ref

Find out which roles has assignment on this context

param: context $context
return: array

message_add_contact($contactid, $blocked = 0, $userid = 0) X-Ref

Add the selected user as a contact for the current user

param: int $contactid the ID of the user to add as a contact
param: int $blocked 1 if you wish to block the contact
param: int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
return: bool/int false if the $contactid isnt a valid user id. True if no changes made.

message_remove_contact($contactid, $userid = 0) X-Ref

Remove a contact.

param: int $contactid the user ID of the contact to remove
param: int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
return: bool returns the result of delete_records()

message_unblock_contact($contactid, $userid = 0) X-Ref

Unblock a contact.

param: int $contactid the user ID of the contact to unblock
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool returns the result of delete_records()

message_block_contact($contactid, $userid = 0) X-Ref

Block a user.

param: int $contactid the user ID of the user to block
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool

Load a user's contact record

param: int $contactid the user ID of the user whose contact record you want
return: array message contacts

get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",&$totalcount, $limitfrom="", $limitnum="") X-Ref

Returns list of courses, for whole site, or category

Similar to get_courses, but allows paging
Important: Using c.* for fields is extremely expensive because
we are using distinct. You almost _NEVER_ need all the fields
in such a large SELECT

param: string|int $categoryid Either a category id or 'all' for everything
param: string $sort A field and direction to sort by
param: string $fields The additional fields to return
param: int $totalcount Reference for the number of courses
param: string $limitfrom The course to start from
param: string $limitnum The number of courses to limit to
return: array Array of courses

report_insights_context_insights(\context $context) X-Ref

Returns the models that generated insights in the provided context.

param: \context $context
return: int[]

get_module_metadata($course, $modnames, $sectionreturn = null) X-Ref

Retrieve all metadata for the requested modules

param: object $course The Course
param: array $modnames An array containing the list of modules and their
param: int $sectionreturn The section to return to
return: array A list of stdClass objects containing metadata about each

cron_run_single_task(\core\task\scheduled_task $task) X-Ref

Runs a single cron task. This function assumes it is displaying output in pseudo-CLI mode.

The function will fail if the task is disabled.

Warning: Because this function closes the browser session, it may not be safe to continue
with other processing (other than displaying the rest of the page) after using this function!

param: \core\task\scheduled_task $task Task to run
return: bool True if cron run successful

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $enrolid = 0, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

Get all of the allowed types for all of the courses and groups
the logged in user belongs to.

The returned array will optionally have 5 keys:
'user' : true if the logged in user can create user events
'site' : true if the logged in user can create site events
'category' : array of course categories that the user can create events for
'course' : array of courses that the user can create events for
'group': array of groups that the user can create events for
'groupcourses' : array of courses that the groups belong to (can
be different from the list in 'course'.
return: array The array of allowed types.

Gets array of all groups in a set of course.

param: array $courses Array of course objects or course ids.
return: array Array of groups indexed by course id.

Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists
param: stdClass $qhandler A row from the events_queued_handler table

Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise

get_roles_on_exact_context(context $context) X-Ref

This function finds the roles assigned directly to this context only
i.e. no roles in parent contexts

param: context $context
return: array

get_roles_with_assignment_on_context(context $context) X-Ref

Find out which roles has assignment on this context

param: context $context
return: array

message_add_contact($contactid, $blocked = 0, $userid = 0) X-Ref

Add the selected user as a contact for the current user

param: int $contactid the ID of the user to add as a contact
param: int $blocked 1 if you wish to block the contact
param: int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
return: bool/int false if the $contactid isnt a valid user id. True if no changes made.

message_remove_contact($contactid, $userid = 0) X-Ref

Remove a contact.

param: int $contactid the user ID of the contact to remove
param: int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
return: bool returns the result of delete_records()

message_unblock_contact($contactid, $userid = 0) X-Ref

Unblock a contact.

param: int $contactid the user ID of the contact to unblock
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool returns the result of delete_records()

message_block_contact($contactid, $userid = 0) X-Ref

Block a user.

param: int $contactid the user ID of the user to block
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool

Load a user's contact record

param: int $contactid the user ID of the user whose contact record you want
return: array message contacts

get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",&$totalcount, $limitfrom="", $limitnum="") X-Ref

Returns list of courses, for whole site, or category

Similar to get_courses, but allows paging
Important: Using c.* for fields is extremely expensive because
we are using distinct. You almost _NEVER_ need all the fields
in such a large SELECT

param: string|int $categoryid Either a category id or 'all' for everything
param: string $sort A field and direction to sort by
param: string $fields The additional fields to return
param: int $totalcount Reference for the number of courses
param: string $limitfrom The course to start from
param: string $limitnum The number of courses to limit to
return: array Array of courses

report_insights_context_insights(\context $context) X-Ref

Returns the models that generated insights in the provided context.

param: \context $context
return: int[]

get_module_metadata($course, $modnames, $sectionreturn = null) X-Ref

Retrieve all metadata for the requested modules

param: object $course The Course
param: array $modnames An array containing the list of modules and their
param: int $sectionreturn The section to return to
return: array A list of stdClass objects containing metadata about each

cron_run_single_task(\core\task\scheduled_task $task) X-Ref

Runs a single cron task. This function assumes it is displaying output in pseudo-CLI mode.

The function will fail if the task is disabled.

Warning: Because this function closes the browser session, it may not be safe to continue
with other processing (other than displaying the rest of the page) after using this function!

param: \core\task\scheduled_task $task Task to run
return: bool True if cron run successful

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $enrolid = 0, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

Get all of the allowed types for all of the courses and groups
the logged in user belongs to.

The returned array will optionally have 5 keys:
'user' : true if the logged in user can create user events
'site' : true if the logged in user can create site events
'category' : array of course categories that the user can create events for
'course' : array of courses that the user can create events for
'group': array of groups that the user can create events for
'groupcourses' : array of courses that the groups belong to (can
be different from the list in 'course'.
return: array The array of allowed types.

Gets array of all groups in a set of course.

param: array $courses Array of course objects or course ids.
return: array Array of groups indexed by course id.

Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists
param: stdClass $qhandler A row from the events_queued_handler table

Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise

get_roles_on_exact_context(context $context) X-Ref

This function finds the roles assigned directly to this context only
i.e. no roles in parent contexts

param: context $context
return: array

get_roles_with_assignment_on_context(context $context) X-Ref

Find out which roles has assignment on this context

param: context $context
return: array

message_add_contact($contactid, $blocked = 0, $userid = 0) X-Ref

Add the selected user as a contact for the current user

param: int $contactid the ID of the user to add as a contact
param: int $blocked 1 if you wish to block the contact
param: int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
return: bool/int false if the $contactid isnt a valid user id. True if no changes made.

message_remove_contact($contactid, $userid = 0) X-Ref

Remove a contact.

param: int $contactid the user ID of the contact to remove
param: int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
return: bool returns the result of delete_records()

message_unblock_contact($contactid, $userid = 0) X-Ref

Unblock a contact.

param: int $contactid the user ID of the contact to unblock
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool returns the result of delete_records()

message_block_contact($contactid, $userid = 0) X-Ref

Block a user.

param: int $contactid the user ID of the user to block
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool

Load a user's contact record

param: int $contactid the user ID of the user whose contact record you want
return: array message contacts

get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",&$totalcount, $limitfrom="", $limitnum="") X-Ref

Returns list of courses, for whole site, or category

Similar to get_courses, but allows paging
Important: Using c.* for fields is extremely expensive because
we are using distinct. You almost _NEVER_ need all the fields
in such a large SELECT

param: string|int $categoryid Either a category id or 'all' for everything
param: string $sort A field and direction to sort by
param: string $fields The additional fields to return
param: int $totalcount Reference for the number of courses
param: string $limitfrom The course to start from
param: string $limitnum The number of courses to limit to
return: array Array of courses

report_insights_context_insights(\context $context) X-Ref

Returns the models that generated insights in the provided context.

param: \context $context
return: int[]

get_module_metadata($course, $modnames, $sectionreturn = null) X-Ref

Retrieve all metadata for the requested modules

param: object $course The Course
param: array $modnames An array containing the list of modules and their
param: int $sectionreturn The section to return to
return: array A list of stdClass objects containing metadata about each

cron_run_single_task(\core\task\scheduled_task $task) X-Ref

Runs a single cron task. This function assumes it is displaying output in pseudo-CLI mode.

The function will fail if the task is disabled.

Warning: Because this function closes the browser session, it may not be safe to continue
with other processing (other than displaying the rest of the page) after using this function!

param: \core\task\scheduled_task $task Task to run
return: bool True if cron run successful

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $enrolid = 0, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

Get all of the allowed types for all of the courses and groups
the logged in user belongs to.

The returned array will optionally have 5 keys:
'user' : true if the logged in user can create user events
'site' : true if the logged in user can create site events
'category' : array of course categories that the user can create events for
'course' : array of courses that the user can create events for
'group': array of groups that the user can create events for
'groupcourses' : array of courses that the groups belong to (can
be different from the list in 'course'.
return: array The array of allowed types.

Gets array of all groups in a set of course.

param: array $courses Array of course objects or course ids.
return: array Array of groups indexed by course id.

Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists
param: stdClass $qhandler A row from the events_queued_handler table

Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise

get_roles_on_exact_context(context $context) X-Ref

This function finds the roles assigned directly to this context only
i.e. no roles in parent contexts

param: context $context
return: array

get_roles_with_assignment_on_context(context $context) X-Ref

Find out which roles has assignment on this context

param: context $context
return: array

message_add_contact($contactid, $blocked = 0, $userid = 0) X-Ref

Add the selected user as a contact for the current user

param: int $contactid the ID of the user to add as a contact
param: int $blocked 1 if you wish to block the contact
param: int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
return: bool/int false if the $contactid isnt a valid user id. True if no changes made.

message_remove_contact($contactid, $userid = 0) X-Ref

Remove a contact.

param: int $contactid the user ID of the contact to remove
param: int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
return: bool returns the result of delete_records()

message_unblock_contact($contactid, $userid = 0) X-Ref

Unblock a contact.

param: int $contactid the user ID of the contact to unblock
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool returns the result of delete_records()

message_block_contact($contactid, $userid = 0) X-Ref

Block a user.

param: int $contactid the user ID of the user to block
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool

Load a user's contact record

param: int $contactid the user ID of the user whose contact record you want
return: array message contacts

get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",&$totalcount, $limitfrom="", $limitnum="") X-Ref

Returns list of courses, for whole site, or category

Similar to get_courses, but allows paging
Important: Using c.* for fields is extremely expensive because
we are using distinct. You almost _NEVER_ need all the fields
in such a large SELECT

param: string|int $categoryid Either a category id or 'all' for everything
param: string $sort A field and direction to sort by
param: string $fields The additional fields to return
param: int $totalcount Reference for the number of courses
param: string $limitfrom The course to start from
param: string $limitnum The number of courses to limit to
return: array Array of courses

report_insights_context_insights(\context $context) X-Ref

Returns the models that generated insights in the provided context.

param: \context $context
return: int[]

get_module_metadata($course, $modnames, $sectionreturn = null) X-Ref

Retrieve all metadata for the requested modules

param: object $course The Course
param: array $modnames An array containing the list of modules and their
param: int $sectionreturn The section to return to
return: array A list of stdClass objects containing metadata about each

cron_run_single_task(\core\task\scheduled_task $task) X-Ref

Runs a single cron task. This function assumes it is displaying output in pseudo-CLI mode.

The function will fail if the task is disabled.

Warning: Because this function closes the browser session, it may not be safe to continue
with other processing (other than displaying the rest of the page) after using this function!

param: \core\task\scheduled_task $task Task to run
return: bool True if cron run successful

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $enrolid = 0, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

Get all of the allowed types for all of the courses and groups
the logged in user belongs to.

The returned array will optionally have 5 keys:
'user' : true if the logged in user can create user events
'site' : true if the logged in user can create site events
'category' : array of course categories that the user can create events for
'course' : array of courses that the user can create events for
'group': array of groups that the user can create events for
'groupcourses' : array of courses that the groups belong to (can
be different from the list in 'course'.
return: array The array of allowed types.

Gets array of all groups in a set of course.

param: array $courses Array of course objects or course ids.
return: array Array of groups indexed by course id.

Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists
param: stdClass $qhandler A row from the events_queued_handler table

Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise

get_roles_on_exact_context(context $context) X-Ref

This function finds the roles assigned directly to this context only
i.e. no roles in parent contexts

param: context $context
return: array

get_roles_with_assignment_on_context(context $context) X-Ref

Find out which roles has assignment on this context

param: context $context
return: array

message_add_contact($contactid, $blocked = 0, $userid = 0) X-Ref

Add the selected user as a contact for the current user

param: int $contactid the ID of the user to add as a contact
param: int $blocked 1 if you wish to block the contact
param: int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
return: bool/int false if the $contactid isnt a valid user id. True if no changes made.

message_remove_contact($contactid, $userid = 0) X-Ref

Remove a contact.

param: int $contactid the user ID of the contact to remove
param: int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
return: bool returns the result of delete_records()

message_unblock_contact($contactid, $userid = 0) X-Ref

Unblock a contact.

param: int $contactid the user ID of the contact to unblock
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool returns the result of delete_records()

message_block_contact($contactid, $userid = 0) X-Ref

Block a user.

param: int $contactid the user ID of the user to block
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool

Load a user's contact record

param: int $contactid the user ID of the user whose contact record you want
return: array message contacts

get_courses_page($categoryid="all", $sort="c.sortorder ASC", $fields="c.*",&$totalcount, $limitfrom="", $limitnum="") X-Ref

Returns list of courses, for whole site, or category

Similar to get_courses, but allows paging
Important: Using c.* for fields is extremely expensive because
we are using distinct. You almost _NEVER_ need all the fields
in such a large SELECT

param: string|int $categoryid Either a category id or 'all' for everything
param: string $sort A field and direction to sort by
param: string $fields The additional fields to return
param: int $totalcount Reference for the number of courses
param: string $limitfrom The course to start from
param: string $limitnum The number of courses to limit to
return: array Array of courses

report_insights_context_insights(\context $context) X-Ref

Returns the models that generated insights in the provided context.

param: \context $context
return: int[]

get_module_metadata($course, $modnames, $sectionreturn = null) X-Ref

Retrieve all metadata for the requested modules

param: object $course The Course
param: array $modnames An array containing the list of modules and their
param: int $sectionreturn The section to return to
return: array A list of stdClass objects containing metadata about each

cron_run_single_task(\core\task\scheduled_task $task) X-Ref

Runs a single cron task. This function assumes it is displaying output in pseudo-CLI mode.

The function will fail if the task is disabled.

Warning: Because this function closes the browser session, it may not be safe to continue
with other processing (other than displaying the rest of the page) after using this function!

param: \core\task\scheduled_task $task Task to run
return: bool True if cron run successful

cron_execute_plugin_type($plugintype, $description = null) X-Ref

Executes cron functions for a specific type of plugin.

param: string $plugintype Plugin type (e.g. 'report')
param: string $description If specified, will display 'Starting (whatever)'

cron_bc_hack_plugin_functions($plugintype, $plugins) X-Ref

Used to add in old-style cron functions within plugins that have not been converted to the
new standard API. (The standard API is frankenstyle_name_cron() in lib.php; some types used
cron.php and some used a different name.)

param: string $plugintype Plugin type e.g. 'report'
param: array $plugins Array from plugin name (e.g. 'report_frog') to function name (e.g.
return: array Revised version of $plugins that adds in any extra plugin functions found by

user_get_participants_sql($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the SQL used by the participants table.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles and -1 no roles
param: int $enrolid The enrolment id, 0 means all enrolment methods will be returned.
param: int $statusid The user enrolment status, -1 means all enrolments regardless of the status will be returned, if allowed.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: array

user_get_total_participants($courseid, $groupid = 0, $accesssince = 0, $roleid = 0, $enrolid = 0, $statusid = -1,$search = '', $additionalwhere = '', $additionalparams = array() X-Ref

Returns the total number of participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access, 0 means any time
param: int $roleid The role id, 0 means all roles
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string|array $search The search that was performed, empty means perform no search
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
return: int

user_get_participants($courseid, $groupid = 0, $accesssince, $roleid, $enrolid = 0, $statusid, $search,$additionalwhere = '', $additionalparams = array() X-Ref

Returns the participants for a given course.

param: int $courseid The course id
param: int $groupid The groupid, 0 means all groups and USERSWITHOUTGROUP no group
param: int $accesssince The time since last access
param: int $roleid The role id
param: int $enrolid The applied filter for the user enrolment ID.
param: int $status The applied filter for the user's enrolment status.
param: string $search The search that was performed
param: string $additionalwhere Any additional SQL to add to where
param: array $additionalparams The additional params
param: string $sort The SQL sort
param: int $limitfrom return a subset of records, starting at this point (optional).
param: int $limitnum return a subset comprising this many records (optional, required if $limitfrom is set).
return: moodle_recordset

Class: instead - X-Ref

get_referer() X-Ref

is_web_crawler() X-Ref

completion_cron() X-Ref

tag_type_set() X-Ref

tag_get_tags() X-Ref

tag_get_id() X-Ref

tag_rename() X-Ref

tag_add() X-Ref

tag_assign() X-Ref

tag_set_flag() X-Ref

tag_unset_flag() X-Ref

tag_print_cloud() X-Ref

tag_normalize() X-Ref

tag_set() X-Ref

tag_set_add() X-Ref

tag_set_delete() X-Ref

tag_get() X-Ref

tag_delete() X-Ref

tag_cleanup() X-Ref

tag_cron() X-Ref

tag_find_tags() X-Ref

tag_get_name() X-Ref

tag_cloud_sort() X-Ref

events_load_def() X-Ref

events_dispatch() X-Ref

events_cron() X-Ref

site_scale_used() X-Ref

get_records_csv() X-Ref

put_records_csv() X-Ref

css_is_colour() X-Ref

css_is_width() X-Ref

message_search() X-Ref

print_log() X-Ref

print_mnet_log() X-Ref

print_log_csv() X-Ref

print_log_xls() X-Ref

print_log_ods() X-Ref

get_logs() X-Ref

message_get_recent_conversations($userorid, $limitfrom = 0, $limitto = 100) X-Ref

calendar_cron() X-Ref

allow_override() X-Ref

allow_assign() X-Ref

allow_switch() X-Ref

question_is_only_toplevel_category_in_context() X-Ref

Get all of the allowed types for all of the courses and groups
the logged in user belongs to.

The returned array will optionally have 5 keys:
'user' : true if the logged in user can create user events
'site' : true if the logged in user can create site events
'category' : array of course categories that the user can create events for
'course' : array of courses that the user can create events for
'group': array of groups that the user can create events for
'groupcourses' : array of courses that the groups belong to (can
be different from the list in 'course'.
return: array The array of allowed types.

Gets array of all groups in a set of course.

param: array $courses Array of course objects or course ids.
return: array Array of groups indexed by course id.

Gets the capabilities that have been cached in the database for this
component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
return: array of events

Remove all event handlers and queued events

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'

Deletes cached events that are no longer needed by the component.

param: string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
param: array $cachedhandlers array of the cached events definitions that will be
return: int number of unused handlers that have been removed

Removes this queued handler from the events_queued_handler table

Removes events_queue record from events_queue if no more references to this event object exists
param: stdClass $qhandler A row from the events_queued_handler table

Returns handlers for given event. Uses caching for better perf.

param: string $eventname name of event or 'reset'
return: array|false array of handlers or false otherwise

get_roles_on_exact_context(context $context) X-Ref

This function finds the roles assigned directly to this context only
i.e. no roles in parent contexts

param: context $context
return: array

get_roles_with_assignment_on_context(context $context) X-Ref

Find out which roles has assignment on this context

param: context $context
return: array

message_add_contact($contactid, $blocked = 0, $userid = 0) X-Ref

Add the selected user as a contact for the current user

param: int $contactid the ID of the user to add as a contact
param: int $blocked 1 if you wish to block the contact
param: int $userid the user ID of the user we want to add the contact for, defaults to current user if not specified.
return: bool/int false if the $contactid isnt a valid user id. True if no changes made.

message_remove_contact($contactid, $userid = 0) X-Ref

Remove a contact.

param: int $contactid the user ID of the contact to remove
param: int $userid the user ID of the user we want to remove the contacts for, defaults to current user if not specified.
return: bool returns the result of delete_records()

message_unblock_contact($contactid, $userid = 0) X-Ref

Unblock a contact.

param: int $contactid the user ID of the contact to unblock
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool returns the result of delete_records()

message_block_contact($contactid, $userid = 0) X-Ref

Block a user.

param: int $contactid the user ID of the user to block
param: int $userid the user ID of the user we want to unblock the contact for, defaults to current user
return: bool