Moodle 3.11 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

events_cleanup() X-Ref

events_dequeue() X-Ref

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, $accesssince, $roleid, $enrolid, $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

Returns the list of full course categories to be used in html_writer::select()

Calls {@see core_course_category::make_categories_list()} to build the list.

return: array array mapping course category id to the display name

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

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

events_cleanup() X-Ref

events_dequeue() X-Ref

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, $accesssince, $roleid, $enrolid, $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

Returns the list of full course categories to be used in html_writer::select()

Calls {@see core_course_category::make_categories_list()} to build the list.

return: array array mapping course category id to the display name

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

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

events_cleanup() X-Ref

events_dequeue() X-Ref

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, $accesssince, $roleid, $enrolid, $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

Returns the list of full course categories to be used in html_writer::select()

Calls {@see core_course_category::make_categories_list()} to build the list.

return: array array mapping course category id to the display name

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

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

events_cleanup() X-Ref

events_dequeue() X-Ref

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, $accesssince, $roleid, $enrolid, $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

Returns the list of full course categories to be used in html_writer::select()

Calls {@see core_course_category::make_categories_list()} to build the list.

return: array array mapping course category id to the display name

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

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

events_cleanup() X-Ref

events_dequeue() X-Ref

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, $accesssince, $roleid, $enrolid, $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

Returns the list of full course categories to be used in html_writer::select()

Calls {@see core_course_category::make_categories_list()} to build the list.

return: array array mapping course category id to the display name

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.

Also works for custom fields.

param: string $field Field name, e.g. 'phone1'
return: string Text description taken from language file, e.g. 'Phone number'

get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) X-Ref

A centralised location for the all name fields. Returns an array / sql string snippet.

param: bool $returnsql True for an sql select field snippet.
param: string $tableprefix table query prefix to use in front of each field.
param: string $prefix prefix added to the name fields e.g. authorfirstname.
param: string $fieldprefix sql field prefix e.g. id AS userid.
param: bool $order moves firstname and lastname to the top of the array / start of the string.
return: array|string All name fields.

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

events_cleanup() X-Ref

events_dequeue() X-Ref

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, $accesssince, $roleid, $enrolid, $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

Returns the list of full course categories to be used in html_writer::select()

Calls {@see core_course_category::make_categories_list()} to build the list.

return: array array mapping course category id to the display name

get_extra_user_fields($context, $already = array() X-Ref

Checks if current user is shown any extra fields when listing users.

Does not include any custom profile fields.

param: object $context Context
param: array $already Array of fields that we're going to show anyway
return: array Array of field names from user table, not including anything

get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array() X-Ref

If the current user is to be shown extra user fields when listing or
selecting users, returns a string suitable for including in an SQL select
clause to retrieve those fields.

Does not include any custom profile fields.

param: context $context Context
param: string $alias Alias of user table, e.g. 'u' (default none)
param: string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
param: array $already Array of fields that we're going to include anyway so don't list them (default none)
return: string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank