`'. get_string('typecourse', 'calendar') .'`

◆ badges_get_site_backpack()

badges_get_site_backpack	(		$id,
		int	$userid = 0 )

Get a site backpacks by id for a particular user or site (if userid is 0)

Parameters

int	$id	The backpack id.
int	$userid	The owner of the backpack, 0 if it's a sitewide backpack else a user's site backpack

Return values

stdClass

◆ badges_get_site_backpacks()

badges_get_site_backpacks ( )

List the backpacks at site level.

Return values

array(stdClass)

◆ badges_get_site_primary_backpack()

badges_get_site_primary_backpack ( )

Get the primary backpack for the site.

Return values

stdClass

◆ badges_get_user_backpack()

badges_get_user_backpack ( ?int $userid = 0 )

Get the user backpack for the currently logged in user OR the provided user.

Parameters

int | null $userid The user whose backpack you're requesting for. If null, get the logged in user's backpack

Return values

mixed The user's backpack or none.

Exceptions

◆ badges_get_user_badges()

badges_get_user_badges	(	$userid,
		$courseid = 0,
		$page = 0,
		$perpage = 0,
		$search = '',
		$onlypublic = false )

Get badges for a specific user.

Parameters

int	$userid	User ID
int	$courseid	Badges earned by a user in a specific course
int	$page	The page or records to return
int	$perpage	The number of records to return per page
string	$search	A simple string to search for
bool	$onlypublic	Return only public badges

Return values

array of badges ordered by decreasing date of issue

◆ badges_handle_course_deletion()

badges_handle_course_deletion ( $courseid )

Handles what happens to the course badges when a course is deleted.

Parameters

int $courseid course ID.

Return values

void.

◆ badges_list_criteria()

badges_list_criteria ( $enabled = true )

Return all the enabled criteria types for this site.

Parameters

boolean $enabled

Return values

array

◆ badges_local_backpack_js()

badges_local_backpack_js ( $checksite = false )

No js files are required for backpack support.

This only exists to directly support the custom V1 backpack api.

Deprecated: Since Moodle 3.11.

Parameters

boolean $checksite Call check site function.

Return values

void

◆ badges_notify_badge_award()

badges_notify_badge_award	(	badge	$badge,
			$userid,
			$issued,
			$filepathhash )

Sends notifications to users about awarded badges.

Parameters

core_badges\badge	$badge	Badge that was issued
int	$userid	Recipient ID
string	$issued	Unique hash of an issued badge
string	$filepathhash	File path hash of an issued badge for attachments

◆ badges_open_badges_backpack_api()

badges_open_badges_backpack_api ( ?int $backpackid = null )

Is any backpack enabled that supports open badges V1?

Parameters

int | null $backpackid Check the version of the given id OR if null the sitewide backpack

Return values

boolean

◆ badges_process_badge_image()

badges_process_badge_image	(	badge	$badge,
			$iconfile )

Process badge image from form data.

Parameters

badge	$badge	Badge object
string	$iconfile	Original file

◆ badges_save_backpack_credentials()

badges_save_backpack_credentials ( stdClass $data )

Create a backpack with the provided details.

Stores the auth details of the backpack

Parameters

stdClass $data Backpack specific data.

Return values

int	The id of the external backpack that the credentials correspond to

◆ badges_save_external_backpack()

badges_save_external_backpack ( stdClass $data )

Perform the actual create/update of external bakpacks.

Any checks on the validity of the id will need to be performed before it reaches this function.

Parameters

stdClass $data The backpack data we are updating/inserting

Return values

int	Returns the id of the new/updated record

◆ badges_send_verification_email()

badges_send_verification_email	(	$email,
		$backpackid,
		$backpackpassword )

Create and send a verification email to the email address supplied.

Since we're not sending this email to a user, email_to_user can't be used but this function borrows largely the code from that process.

Parameters

string	$email	the email address to send the verification email to.
int	$backpackid	the id of the backpack to connect to
string	$backpackpassword	the user entered password to connect to this backpack

Return values

true	if the email was sent successfully, false otherwise.

◆ badges_setup_backpack_js()

badges_setup_backpack_js ( )

Loads JS files required for backpack support.

Deprecated: Since Moodle 3.11.

Return values

void

◆ badges_update_site_backpack()

badges_update_site_backpack	(		$id,
			$data )

Update the backpack with this id.

Parameters

integer	$id	The backpack to edit
stdClass	$data	The new backpack data.

Return values

boolean

◆ badges_user_has_backpack()

badges_user_has_backpack ( $userid )

Checks if user has external backpack connected.

Parameters

int $userid ID of a user.

Return values

bool	True\|False whether backpack connection exists.

◆ badges_verify_backpack()

badges_verify_backpack ( int $backpackid )

Attempt to authenticate with a backpack credentials and return an error if the authentication fails.

If external backpacks are not enabled or the backpack version is different from OBv2, this will not perform any test.

Parameters

int $backpackid Backpack identifier to verify.

Return values

string The result of the verification process.

◆ badges_verify_site_backpack()

badges_verify_site_backpack ( )

Attempt to authenticate with the site backpack credentials and return an error if the authentication fails.

If external backpacks are not enabled, this will not perform any test.

Return values

string

◆ behat_check_config_vars()

behat_check_config_vars ( )

Checks that the behat config vars are properly set.

Return values

void	Stops execution with error code if something goes wrong.

◆ behat_clean_init_config()

behat_clean_init_config ( )

Restrict the config.php settings allowed.

When running the behat features the config.php settings should not affect the results.

Return values

void

◆ behat_error()

behat_error	(		$errorcode,
			$text = '' )

Exits with an error code.

Parameters

mixed	$errorcode
string	$text

Return values

void	Stops execution with error code

◆ behat_error_handler()

behat_error_handler	(	$errno,
		$errstr,
		$errfile,
		$errline )

PHP errors handler to use when running behat tests.

Adds specific CSS classes to identify the messages.

Parameters

int	$errno
string	$errstr
string	$errfile
int	$errline

Return values

bool

◆ behat_get_command_flags()

behat_get_command_flags	(	string	$option,
			$value )

Get command flags for an option/value combination.

Parameters

string	$option
string \| bool \| null	$value

Return values

string

◆ behat_get_error_string()

behat_get_error_string ( $errtype )

Return logical error string.

Parameters

int $errtype php error type.

Return values

string string which will be returned.

◆ behat_get_run_process()

behat_get_run_process ( )

Get behat run process from either $_SERVER or command config.

Return values

bool|int false if single run, else run process number.

◆ behat_get_shutdown_process_errors()

behat_get_shutdown_process_errors ( )

Return php errors save which were save during shutdown.

Return values

array

◆ behat_is_requested_url()

behat_is_requested_url ( $url )

Checks if the URL requested by the user matches the provided argument.

Parameters

string $url

Return values

bool	Returns true if it matches.

◆ behat_is_test_site()

behat_is_test_site ( )

Should we switch to the test site data?

Return values

bool

◆ behat_update_vars_for_process()

behat_update_vars_for_process ( )

Fix variables for parallel behat testing.

behat_wwwroot = behat_wwwroot{behatrunprocess}
behat_dataroot = behat_dataroot{behatrunprocess}
behat_prefix = behat_prefix.{behatrunprocess}_ (For oracle it will be firstletter of prefix and behatrunprocess)

◆ block_add_block_ui()

block_add_block_ui	(		$page,
			$output )

Functions update the blocks if required by the request parameters ==========.

Return a block_contents representing the add a new block UI, if this user is allowed to see it.

Return values

block_contents an appropriate block_contents, or null if the user cannot add any blocks here.

◆ block_instance()

block_instance	(	$blockname,
		$instance = NULL,
		$page = NULL )

Creates a new instance of the specified block class.

Parameters

string	$blockname	the name of the block.
stdClass	$instance	block_instances DB table row (optional).
moodle_page	$page	the page this block is appearing on.

Return values

block_base the requested block instance.

◆ block_instance_by_id()

block_instance_by_id ( $blockinstanceid )

Returns a new instance of the specified block instance id.

Parameters

int $blockinstanceid

Return values

block_base the requested block instance.

◆ block_load_class()

block_load_class ( $blockname )

Load the block class for a particular type of block.

Parameters

string $blockname the name of the block.

Return values

boolean success or failure.

◆ block_method_result()

block_method_result	(	$blockname,
		$method,
		$param = NULL )

Helper functions for working with block classes ============================.

Call a class method (one that does not require a block instance) on a block class.

Parameters

string	$blockname	the name of the block.
string	$method	the method name.
array	$param	parameters to pass to the method.

Return values

mixed whatever the method returns.

◆ blocks_add_default_course_blocks()

blocks_add_default_course_blocks ( $course )

Add the default blocks to a course.

Parameters

object $course a course object.

◆ blocks_add_default_system_blocks()

blocks_add_default_system_blocks ( )

Add the default system-context blocks.

E.g. the admin tree.

◆ blocks_delete_all_for_context()

blocks_delete_all_for_context ( $contextid )

Delete all the blocks that belong to a particular context.

Parameters

int $contextid the context id.

◆ blocks_delete_instance()

blocks_delete_instance	(	$instance,
		$nolongerused = false,
		$skipblockstables = false )

Delete a block, and associated data.

Parameters

object	$instance	a row from the block_instances table
bool	$nolongerused	legacy parameter. Not used, but kept for backwards compatibility.
bool	$skipblockstables	for internal use only. Makes

See also: blocks_delete_all_for_context() more efficient.

◆ blocks_delete_instances()

blocks_delete_instances ( $instanceids )

Delete multiple blocks at once.

Parameters

array $instanceids A list of block instance ID.

◆ blocks_find_block()

blocks_find_block	(		$blockid,
			$blocksarray )

Find a given block by its blockid within a provide array.

Parameters

int	$blockid
array	$blocksarray

Return values

bool|object Instance if found else false

◆ blocks_get_default_site_course_blocks()

blocks_get_default_site_course_blocks ( )

Return values

array the blocks that should be added to the site course by default.

◆ blocks_get_record()

blocks_get_record	(		$blockid = NULL,
			$notusedanymore = false )

Get the block record for a particular blockid - that is, a particular type os block.

Parameters

	$int	blockid block type id. If null, an array of all block types is returned.
bool	$notusedanymore	No longer used.

Return values

array|object row from block table, or all rows.

◆ blocks_name_allowed_in_format()

blocks_name_allowed_in_format	(		$name,
			$pageformat )

Check that a given name is in a permittable format.

Parameters

string	$name
string	$pageformat

Return values

bool

◆ blocks_parse_default_blocks_list()

blocks_parse_default_blocks_list ( $blocksstr )

Parse a list of default blocks.

See config-dist for a description of the format.

Parameters

string $blocksstr Determines the starting point that the blocks are added in the region.

Return values

array the parsed list of default blocks

◆ blocks_remove_inappropriate()

blocks_remove_inappropriate ( $course )

Actually delete from the database any blocks that are currently on this page, but which should not be there according to blocks_name_allowed_in_format.

Todo: Write/Fix this function. Currently returns immediately

Parameters

$course

◆ blocks_set_visibility()

blocks_set_visibility	(	$instance,
		$page,
		$newvisibility )

Set a block to be visible or hidden on a particular page.

Parameters

object	$instance	a row from the block_instances, preferably LEFT JOINed with the block_positions table as return by block_manager.
moodle_page	$page	the back to set the visibility with respect to.
integer	$newvisibility	1 for visible, 0 for hidden.

◆ blog_get_context_url()

blog_get_context_url ( )

Deprecated: since Moodle 2.5 MDL-27814 - please do not use this function any more.

◆ bounded_number()

bounded_number	(	$min,
		$value,
		$max )

Used to make sure that $min <= $value <= $max.

Make sure that value is between min, and max

Parameters

int	$min	The minimum value
int	$value	The value to check
int	$max	The maximum value

Return values

int

◆ break_up_long_words()

break_up_long_words	(	$string,
		$maxsize = 20,
		$cutchar = ' ' )

Given some normal text this function will break up any long words to a given size by inserting the given character.

It's multibyte savvy and doesn't change anything inside html tags.

Parameters

string	$string	the string to be modified
int	$maxsize	maximum length of the string to be returned
string	$cutchar	the string used to represent word breaks

Return values

string

◆ build_context_path()

build_context_path ( )

Deprecated: since 2.2

◆ build_logs_array()

build_logs_array ( )

Deprecated: since Moodle 3.2

◆ build_navigation()

build_navigation ( )

Deprecated: Please use $PAGE->navabar methods instead.

◆ calculate_user_dst_table()

calculate_user_dst_table ( )

Deprecated: since Moodle 2.9

◆ calendar_cron()

calendar_cron ( )

Deprecated: since 3.3

◆ calendar_get_all_allowed_types()

calendar_get_all_allowed_types ( )

Deprecated: since 3.6

◆ calendar_get_block_upcoming()

calendar_get_block_upcoming ( )

Deprecated: since 3.3

◆ calendar_get_mini()

calendar_get_mini ( )

Deprecated: since Moodle 3.4. MDL-59333

◆ calendar_get_upcoming()

calendar_get_upcoming ( )

Deprecated: since Moodle 3.4. MDL-59333

◆ calendar_import_icalendar_events()

calendar_import_icalendar_events	(	$ical,
		$unused = null,
		$subscriptionid = null )

Import events from an iCalendar object into a course calendar.

Parameters

iCalendar	$ical	The iCalendar object.
int	$unused	Deprecated
int	$subscriptionid	The subscription ID.

Return values

string A log of the import progress, including errors.

◆ calendar_normalize_tz()

calendar_normalize_tz ( )

Deprecated: since Moodle 2.9

◆ calendar_preferences_button()

calendar_preferences_button ( )

Deprecated: since Moodle 3.2

◆ calendar_print_month_selector()

calendar_print_month_selector ( )

Deprecated: since 3.3

◆ calendar_process_subscription_row()

calendar_process_subscription_row	(	$subscriptionid,
		$pollinterval,
		$action )

Update a subscription from the form data in one of the rows in the existing subscriptions table.

Parameters

int	$subscriptionid	The ID of the subscription we are acting upon.
int	$pollinterval	The poll interval to use.
int	$action	The action to be performed. One of update or remove.

Exceptions

dml_exception if invalid subscriptionid is provided

Return values

string A log of the import progress, including errors

Deprecated: since Moodle 4.0 MDL-71953

◆ calendar_wday_name()

calendar_wday_name ( )

Deprecated: since 3.3

◆ can_send_from_real_email_address()

can_send_from_real_email_address	(	$from,
		$user,
		$unused = null )

Check to see if a user's real email address should be used for the "From" field.

Parameters

object	$from	The user object for the user we are sending the email from.
object	$user	The user object that we are sending the email to.
array	$unused	No longer used.

Return values

bool	Returns true if we can use the from user's email adress in the "From" field.

◆ can_use_html_editor()

can_use_html_editor ( )

Deprecated: since 2.6

◆ can_use_readonly()

can_use_readonly	(	int	$type,
		string	$sql )

protected

Check if The query qualifies for readonly connection execution Logging queries are exempt, those are write operations that circumvent standard query_start/query_end paths.

Parameters

int	$type	type of query
string	$sql

Return values

bool

◆ can_use_rotated_text()

can_use_rotated_text ( )

Deprecated: since 2.5 - do not use, the textrotate.js will work it out automatically

◆ category_delete_full()

category_delete_full ( )

Deprecated: since 2.5

◆ category_delete_move()

category_delete_move ( )

Deprecated: since 2.5

◆ check_admin_dir_usage()

check_admin_dir_usage ( environment_results $result )

Check whether the admin directory has been configured and warn if so.

The admin directory has been deprecated since Moodle 4.0.

Parameters

environment_results $result

Return values

null|environment_results

◆ check_browser_operating_system()

check_browser_operating_system ( )

Deprecated: since 2.6

◆ check_browser_version()

check_browser_version ( )

Deprecated: since 2.6

◆ check_consecutive_identical_characters()

check_consecutive_identical_characters	(		$password,
			$maxchars )

Check whether the given password has no more than the specified number of consecutive identical characters.

Parameters

string	$password	password to be checked against the password policy
integer	$maxchars	maximum number of consecutive identical characters

Return values

bool

◆ check_database_storage_engine()

check_database_storage_engine ( environment_results $result )

This function verifies that the database is not using an unsupported storage engine.

Parameters

environment_results $result object to update, if relevant

Return values

environment_results|null updated results object, or null if the storage engine is supported

◆ check_database_tables_row_format()

check_database_tables_row_format ( environment_results $result )

This function verifies if the database has tables using innoDB Antelope row format.

Parameters

environment_results $result

Return values

environment_results|null updated results object, or null if no Antelope table has been found.

◆ check_db_prefix_length()

check_db_prefix_length ( environment_results $result )

This function checks that the database prefix ($CFG->prefix) is <= 10.

Parameters

environment_results $result

Return values

environment_results|null updated results object, or null if the prefix check is passing ok.

◆ check_dir_exists()

check_dir_exists	(	$dir,
		$create = true,
		$recursive = true )

Function to check if a directory exists and by default create it if not exists.

Previously this was accepting paths only from dataroot, but we now allow files outside of dataroot if you supply custom paths for some settings in config.php. This function does not verify that the directory is writable.

NOTE: this function uses current file stat cache, please use clearstatcache() before this if you expect that the directories may have been removed recently from a different request.

Parameters

string	$dir	absolute directory path
boolean	$create	directory if does not exist
boolean	$recursive	create directory recursively

Return values

boolean true if directory exists or created, false otherwise

◆ check_gd_version()

check_gd_version ( )

Deprecated

◆ check_igbinary322_version()

check_igbinary322_version ( environment_results $result )

Check if the igbinary extension installed is buggy one.

There are a few php-igbinary versions that are buggy and return any unserialised array with wrong index. This defeats key() and next() operations on them.

This library is used by MUC and also by memcached and redis when available.

Let's inform if there is some problem when:

php 7.2 is being used (php 7.3 and up are immune).
the igbinary extension is installed.
the version of the extension is between 3.2.2 and 3.2.4.
the buggy behaviour is reproduced.

Parameters

environment_results $result object to update, if relevant.

Return values

environment_results|null updated results or null.

◆ check_is_https()

check_is_https ( environment_results $result )

Check if the site is being served using an ssl url.

Note this does not really perform any request neither looks for proxies or other situations. Just looks to wwwroot and warn if it's not using https.

Parameters

environment_results $result $result

Return values

environment_results|null updated results object, or null if the site is https.

◆ check_libcurl_version()

check_libcurl_version ( environment_results $result )

Check if recommended version of libcurl is installed or not.

Parameters

environment_results $result object to update, if relevant.

Return values

environment_results|null updated results or null.

◆ check_max_input_vars()

check_max_input_vars ( environment_results $result )

Environment check for the php setting max_input_vars.

Parameters

environment_results $result

Return values

environment_results|null

◆ check_mod_assignment()

check_mod_assignment ( environment_results $result )

Check whether the mod_assignment is currently being used.

Parameters

environment_results $result

Return values

environment_results|null

◆ check_moodle_environment()

check_moodle_environment	(		$version,
			$env_select = ENV_SELECT_NEWER )

This function checks all the requirements defined in environment.xml.

Parameters

string	$version	version to check.
int	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. Default ENV_SELECT_NEWER (BC)

Return values

array with two elements. The first element true/false, depending on on whether the check passed. The second element is an array of environment_results objects that has detailed information about the checks and which ones passed.

◆ check_mysql_file_format()

check_mysql_file_format ( environment_results $result )

This function verfies that the database has tables using InnoDB Antelope row format.

Parameters

environment_results $result

Return values

environment_results|null updated results object, or null if no Antelope table has been found.

◆ check_mysql_file_per_table()

check_mysql_file_per_table ( environment_results $result )

This function verfies that the database has a setting of one file per table.

This is required for 'utf8mb4'.

Parameters

environment_results $result

Return values

environment_results|null updated results object, or null if innodb_file_per_table = 1.

◆ check_mysql_incomplete_unicode_support()

check_mysql_incomplete_unicode_support ( environment_results $result )

This function checks the database to see if it is using incomplete unicode support.

Parameters

environment_results $result $result

Return values

environment_results|null updated results object, or null if unicode is fully supported.

◆ check_mysql_large_prefix()

check_mysql_large_prefix ( environment_results $result )

This function verfies that the database has the setting of large prefix enabled.

This is required for 'utf8mb4'.

Parameters

environment_results $result

Return values

environment_results|null updated results object, or null if innodb_large_prefix = 1.

◆ check_oracle_usage()

check_oracle_usage ( environment_results $result )

Check whether the Oracle database is currently being used and warn if so.

The Oracle database support will be removed in a future version (4.5) as it is no longer supported by PHP.

Parameters

environment_results $result object to update, if relevant

Return values

environment_results|null updated results or null if the current database is not Oracle.

See also: https://tracker.moodle.org/browse/MDL-80166 for further information.

◆ check_password_policy()

check_password_policy	(		$password,
		&	$errmsg,
			$user = null )

Validate a password against the configured password policy.

Parameters

string	$password	the password to be checked against the password policy
string	$errmsg	the error message to display when the password doesn't comply with the policy.
stdClass	$user	the user object to perform password validation against. Defaults to null if not provided.

Return values

bool	true if the password is valid according to the policy. false otherwise.

◆ check_php_version()

check_php_version ( $version = '5.2.4' )

Returns true if the current version of PHP is greater that the specified one.

Todo: Check PHP version being required here is it too low?

Parameters

string $version The version of php being tested.

Return values

bool

◆ check_sixtyfour_bits()

check_sixtyfour_bits ( environment_results $result )

Check if the site is using 64 bits PHP.

Parameters

environment_results $result

Return values

environment_results|null updated results object, or null if the site is using 64 bits PHP.

◆ check_slasharguments()

check_slasharguments ( environment_results $result )

Method used to check the usage of slasharguments config and display a warning message.

Parameters

environment_results $result object to update, if relevant.

Return values

environment_results|null updated results or null if slasharguments is disabled.

◆ check_tls_libraries()

check_tls_libraries ( environment_results $result )

Checks for up-to-date TLS libraries.

NOTE: this is not currently used, see MDL-57262.

Parameters

environment_results $result object to update, if relevant.

Return values

environment_results|null updated results or null if unoconv path is not executable.

◆ check_unoconv_version()

check_unoconv_version ( environment_results $result )

Method used to check the installed unoconv version.

Parameters

environment_results $result object to update, if relevant.

Return values

environment_results|null updated results or null if unoconv path is not executable.

◆ check_upgrade_key()

check_upgrade_key ( $upgradekeyhash )

Assert the upgrade key is provided, if it is defined.

The upgrade key can be defined in the main config.php as $CFG->upgradekey. If it is defined there, then its value must be provided every time the site is being upgraded, regardless the administrator is logged in or not.

This is supposed to be used at certain places in /admin/index.php only.

Parameters

string | null $upgradekeyhash the SHA-1 of the value provided by the user

◆ check_user_preferences_loaded()

check_user_preferences_loaded	(	stdClass	$user,
			$cachelifetime = 120 )

Refresh user preference cache.

This is used most often for $USER object that is stored in session, but it also helps with performance in cron script.

Preferences for each user are loaded on first use on every page, then again after the timeout expires.

Parameters

stdClass	$user	User object. Preferences are preloaded into 'preference' property
int	$cachelifetime	Cache life time on the current page (in seconds)

Exceptions

Return values

null

◆ check_xmlrpc_usage()

check_xmlrpc_usage ( environment_results $result )

Check whether the XML-RPC protocol is enabled and warn if so.

The XML-RPC protocol will be removed in a future version (4.1) as it is no longer supported by PHP.

See MDL-70889 for further information.

Parameters

environment_results $result

Return values

null|environment_results

◆ choose_from_menu()

choose_from_menu ( )

Deprecated: since Moodle 2.0

◆ clam_change_log()

clam_change_log ( )

Deprecated: since 2.7 - use new file picker instead

◆ clam_handle_infected_file()

clam_handle_infected_file ( )

Deprecated: since 2.7

◆ clam_log_infected()

clam_log_infected ( )

Deprecated: since 2.7 - use new file picker instead

◆ clam_log_upload()

clam_log_upload ( )

Deprecated: since 2.7 - use new file picker instead

◆ clam_message_admins()

clam_message_admins ( )

Deprecated: since Moodle 3.0 - this is a part of clamav plugin now.

◆ clam_replace_infected_file()

clam_replace_infected_file ( )

Deprecated: since 2.7 - infected files are now deleted in file picker

◆ clam_scan_moodle_file()

clam_scan_moodle_file ( )

Deprecated: since 2.7

◆ clean_filename()

clean_filename ( $string )

Cleans a given filename by removing suspicious or troublesome characters.

See also: clean_param()

Parameters

string $string file name

Return values

string cleaned file name

◆ clean_param()

clean_param	(		$param,
			$type )

Used by optional_param() and required_param() to clean the variables and/or cast to specific types, based on an options field.

$course->format = clean_param($course->format, PARAM_ALPHA); $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);

Parameters

mixed	$param	the variable we are cleaning
string	$type	expected format of param after cleaning.

Return values

mixed

Exceptions

◆ clean_param_array()

clean_param_array	(	?array	$param,
			$type,
			$recursive = false )

Makes sure array contains only the allowed types, this function does not validate array key names!

$options = clean_param($options, PARAM_INT);

Parameters

array \| null	$param	the variable array we are cleaning
string	$type	expected format of param after cleaning.
bool	$recursive	clean recursive arrays

Return values

array

Exceptions

◆ clean_text()

clean_text	(	$text,
		$format = FORMAT_HTML,
		$options = array() )

Cleans raw text removing nasties.

Given raw text (eg typed in by a user) this function cleans it up and removes any nasty tags that could mess up Moodle pages through XSS attacks.

The result must be used as a HTML text fragment, this function can not cleanup random parts of html tags such as url or src attributes.

NOTE: the format parameter was deprecated because we can safely clean only HTML.

Parameters

string	$text	The text to be cleaned
int \| string	$format	deprecated parameter, should always contain FORMAT_HTML or FORMAT_MOODLE
array	$options	Array of options; currently only option supported is 'allowid' (if true, does not remove id attributes when cleaning)

Return values

string The cleaned up text

◆ cleanremoteaddr()

cleanremoteaddr	(		$addr,
			$compress = false )

Cleans an ip address.

Internal addresses are now allowed. (Originally local addresses were not allowed.)

Parameters

string	$addr	IPv4 or IPv6 address
bool	$compress	use IPv6 address compression

Return values

string normalised ip address string, null if error

◆ cleanup_contexts()

cleanup_contexts ( )

Deprecated: since 2.2

◆ cleardoubleslashes()

cleardoubleslashes ( $path )

Replace 1 or more slashes or backslashes to 1 slash.

Parameters

string $path The path to strip

Return values

string the path with double slashes removed

◆ cli_error()

cli_error	(		$text,
			$errorcode = 1 )

Write to standard error output and exit with the given code.

Parameters

string	$text
int	$errorcode

Return values

void	(does not return)

◆ cli_execute_parallel()

cli_execute_parallel	(	$cmds,
		$cwd = null,
		$delay = 0 )

Execute commands in parallel.

Parameters

array	$cmds	list of commands to be executed.
string	$cwd	absolute path of working directory.
int	$delay	time in seconds to add delay between each parallel process.

Return values

array list of processes.

◆ cli_get_params()

cli_get_params	(	array	$longoptions,
		array	$shortmapping = null )

Returns cli script parameters.

Parameters

array	$longoptions	array of –style options ex:('verbose'=>false)
array	$shortmapping	array describing mapping of short to long style options ex:('h'=>'help', 'v'=>'verbose')

Return values

array array of arrays, options, unrecognised as optionlongname=>value

◆ cli_heading()

cli_heading	(		$string,
			$return = false )

Print or return section heading string.

Parameters

string	$string	text
bool	$return	false means print, true return as string

Return values

mixed void or string

◆ cli_input()

cli_input	(		$prompt,
			$default = '',
		array	$options = null,
			$casesensitiveoptions = false )

Get input from user.

Parameters

string	$prompt	text prompt, should include possible options
string	$default	default value when enter pressed
array	$options	list of allowed options, empty means any text
bool	$casesensitive	true if options are case sensitive

Return values

string entered text

◆ cli_logo()

cli_logo	(		$padding = 2,
			$return = false )

Print an ASCII version of the Moodle logo.

Parameters

int	$padding	left padding of the logo
bool	$return	should we print directly (false) or return the string (true)

Return values

mixed void or string

◆ cli_problem()

cli_problem ( $text )

Write error notification.

Parameters

$text

Return values

void

◆ cli_separator()

cli_separator ( $return = false )

Print or return section separator string.

Parameters

bool $return false means print, true return as string

Return values

mixed void or string

◆ cli_set_process_title_suffix()

cli_set_process_title_suffix ( string $suffix )

This sets the cli process title suffix.

An example is appending current Task API info so a sysadmin can immediately see what task a cron process is running at any given moment.

Parameters

string $suffix process suffix

◆ cli_write()

cli_write	(		$text,
			$stream = STDOUT )

Write a text to the given stream.

Parameters

string	$text	text to be written
resource	$stream	output stream to be written to, defaults to STDOUT

◆ cli_writeln()

cli_writeln	(		$text,
			$stream = STDOUT )

Write a text followed by an end of line symbol to the given stream.

Parameters

string	$text	text to be written
resource	$stream	output stream to be written to, defaults to STDOUT

◆ close_window()

close_window	(		$delay = 0,
			$reloadopener = false )

Try and close the current window using JavaScript, either immediately, or after a delay.

Echo's out the resulting XHTML & javascript

Parameters

integer	$delay	a delay in seconds before closing the window. Default 0.
boolean	$reloadopener	if true, we will see if this window was a pop-up, and try to reload the parent window before this one closes.

◆ cohort_get_visible_list()

cohort_get_visible_list ( )

Deprecated: since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead

◆ commit_delegated_transaction()

commit_delegated_transaction ( moodle_transaction $transaction )

Indicates delegated transaction finished successfully.

Set written times after outermost transaction finished

Parameters

moodle_transaction $transaction The transaction to commit

Return values

void

Exceptions

dml_transaction_exception Creates and throws transaction related exceptions.

◆ complete_user_login()

complete_user_login	(		$user,
		array	$extrauserinfo = [] )

Call to complete the user login process after authenticate_user_login() has succeeded.

It will setup the $USER variable and other required bits and pieces.

NOTE:

It will NOT log anything – up to the caller to decide what to log.
this function does not set any cookies any more!

Parameters

stdClass	$user
array	$extrauserinfo

Return values

stdClass A $USER object - BC only, do not use

◆ completion_cron()

completion_cron ( )

Deprecated: since Moodle 3.0 MDL-50287 - please do not use this function any more.

◆ complex_random_string()

complex_random_string ( $length = null )

Generate a complex random string (useful for md5 salts)

This function is based on the above random_string() however it uses a larger pool of characters and generates a string between 24 and 32 characters

Parameters

int $length Optional if set generates a string to exactly this length

Return values

string

◆ component_callback()

component_callback	(		$component,
			$function,
		array	$params = array(),
			$default = null )

Invoke component's callback functions.

Parameters

string	$component	frankenstyle component name, e.g. 'mod_quiz'
string	$function	the rest of the function name, e.g. 'cron' will end up calling 'mod_quiz_cron'
array	$params	parameters of callback function
mixed	$default	default value if callback function hasn't been defined, or if it retursn null.

Return values

mixed

◆ component_callback_exists()

component_callback_exists	(		$component,
			$function )

Determine if a component callback exists and return the function name to call.

Note that this function will include the required library files so that the functioname returned can be called directly.

Parameters

string	$component	frankenstyle component name, e.g. 'mod_quiz'
string	$function	the rest of the function name, e.g. 'cron' will end up calling 'mod_quiz_cron'

Return values

mixed Complete function name to call if the callback exists or false if it doesn't.

Exceptions

coding_exception if invalid component specfied

◆ component_class_callback()

component_class_callback	(		$classname,
			$methodname,
		array	$params,
			$default = null )

Call the specified callback method on the provided class.

If the callback returns null, then the default value is returned instead. If the class does not exist, then the default value is returned.

Parameters

string	$classname	The name of the class to call upon.
string	$methodname	The name of the staticically defined method on the class.
array	$params	The arguments to pass into the method.
mixed	$default	The default value.

Return values

mixed The return value.

◆ confirm_sesskey()

confirm_sesskey ( $sesskey = NULL )

Check the sesskey and return true of false for whether it is valid.

(You might like to imagine this function is called sesskey_is_valid().)

Every script that lets the user perform a significant action (that is, changes data in the database) should check the sesskey before doing the action. Depending on your code flow, you may want to use the require_sesskey() helper function.

Parameters

string $sesskey The sesskey value to check (optional). Normally leave this blank and this function will do required_param('sesskey', ...).

Return values

bool	whether the sesskey sent in the request matches the one stored in the session.

◆ connect()

connect	(		$dbhost,
			$dbuser,
			$dbpass,
			$dbname,
			$prefix,
		array	$dboptions = null )

Connect to db The connection parameters processor that sets up stage for master write and slave readonly handles.

Must be called before other methods.

Parameters

string	$dbhost	The database host.
string	$dbuser	The database username.
string	$dbpass	The database username's password.
string	$dbname	The name of the database being connected to.
mixed	$prefix	string means moodle db prefix, false used for external databases where prefix not used
array	$dboptions	driver specific options

Return values

bool true

Exceptions

dml_connection_exception if error

◆ content_to_text()

content_to_text	(		$content,
			$contentformat )

Converts texts or strings to plain text.

When used to convert user input introduced in an editor the text format needs to be passed in $contentformat like we usually do in format_text.
When this function is used for strings that are usually passed through format_string before displaying them we need to set $contentformat to false. This will execute html_to_text as these strings can contain multilang tags if multilang filter is applied to headings.

Parameters

string	$content	The text as entered by the user
int \| false	$contentformat	False for strings or the text format: FORMAT_MOODLE/FORMAT_HTML/FORMAT_PLAIN/FORMAT_MARKDOWN

Return values

string Plain text.

◆ context_instance_preload()

context_instance_preload ( )

Deprecated: since 2.2

◆ context_instance_preload_sql()

context_instance_preload_sql ( )

Deprecated: since 2.2

◆ context_moved()

context_moved ( )

Deprecated: since Moodle 2.2

◆ convert_tabrows_to_tree()

convert_tabrows_to_tree ( )

Deprecated: since 2.5

◆ convert_to_array()

convert_to_array ( $var )

Converts an object into an associative array.

This function converts an object into an associative array by iterating over its public properties. Because this function uses the foreach construct, Iterators are respected. It works recursively on arrays of objects. Arrays and simple values are returned as is.

If class has magic properties, it can implement IteratorAggregate and return all available properties in getIterator()

Parameters

mixed $var

Return values

array

◆ convert_tree_to_html()

convert_tree_to_html ( )

Deprecated: since 2.5

◆ core_login_extend_change_password_form()

core_login_extend_change_password_form	(		$mform,
			$user )

Plugins can extend forms.

Inject form elements into change_password_form.

Parameters

mform	$mform	the form to inject elements into.
stdClass	$user	the user object to use for context.

◆ core_login_extend_forgot_password_form()

core_login_extend_forgot_password_form ( $mform )

Inject form elements into forgot_password_form.

Parameters

mform $mform the form to inject elements into.

◆ core_login_extend_set_password_form()

core_login_extend_set_password_form	(		$mform,
			$user )

Inject form elements into set_password_form.

Parameters

mform	$mform	the form to inject elements into.
stdClass	$user	the user object to use for context.

◆ core_login_extend_signup_form()

core_login_extend_signup_form ( $mform )

Inject form elements into signup_form.

Parameters

mform $mform the form to inject elements into.

◆ core_login_generate_password_reset()

core_login_generate_password_reset ( $user )

Create a new record in the database to track a new password set request for user.

Parameters

object $user the user record, the requester would like a new password set for.

Return values

record created.

◆ core_login_get_return_url()

core_login_get_return_url ( )

Determine where a user should be redirected after they have been logged in.

Return values

string url the user should be redirected to.

◆ core_login_post_change_password_requests()

core_login_post_change_password_requests ( $data )

Plugins can perform post submission actions.

Post change_password_form submission actions.

Parameters

stdClass $data the data object from the submitted form.

◆ core_login_post_forgot_password_requests()

core_login_post_forgot_password_requests ( $data )

Post forgot_password_form submission actions.

Parameters

stdClass $data the data object from the submitted form.

◆ core_login_post_set_password_requests()

core_login_post_set_password_requests	(		$data,
			$user )

Post set_password_form submission actions.

Parameters

stdClass	$data	the data object from the submitted form.
stdClass	$user	the user object for set_password context.

◆ core_login_post_signup_requests()

core_login_post_signup_requests ( $data )

Post signup_form submission actions.

Parameters

stdClass $data the data object from the submitted form.

◆ core_login_process_password_reset()

core_login_process_password_reset	(		$username,
			$email )

Process the password reset for the given user (via username or email).

Parameters

string	$username	the user name
string	$email	the user email

Return values

array an array containing fields indicating the reset status, a info notice and redirect URL.

Since: Moodle 3.4

◆ core_login_process_password_reset_request()

core_login_process_password_reset_request ( )

Processes a user's request to set a new password in the event they forgot the old one.

If no user identifier has been supplied, it displays a form where they can submit their identifier. Where they have supplied identifier, the function will check their status, and send email as appropriate.

◆ core_login_process_password_set()

core_login_process_password_set ( $token )

This function processes a user's submitted token to validate the request to set a new password.

If the user's token is validated, they are prompted to set a new password.

Parameters

string $token the one-use identifier which should verify the password reset request as being valid.

Return values

void

◆ core_login_validate_extend_change_password_form()

core_login_validate_extend_change_password_form	(		$data,
			$user )

Plugins can add additional validation to forms.

Inject validation into change_password_form.

Parameters

array	$data	the data array from submitted form values.
stdClass	$user	the user object to use for context.

Return values

array\$errors the updated array of errors from validation.

◆ core_login_validate_extend_forgot_password_form()

core_login_validate_extend_forgot_password_form ( $data )

Inject validation into forgot_password_form.

Parameters

array $data the data array from submitted form values.

Return values

array\$errors the updated array of errors from validation.

◆ core_login_validate_extend_set_password_form()

core_login_validate_extend_set_password_form	(		$data,
			$user )

Inject validation into set_password_form.

Parameters

array	$data	the data array from submitted form values.
stdClass	$user	the user object to use for context.

Return values

array\$errors the updated array of errors from validation.

◆ core_login_validate_extend_signup_form()

core_login_validate_extend_signup_form ( $data )

Inject validation into signup_form.

Parameters

array $data the data array from submitted form values.

Return values

array\$errors the updated array of errors from validation.

◆ core_login_validate_forgot_password_data()

core_login_validate_forgot_password_data ( $data )

Validates the forgot password form data.

This is used by the forgot_password_form and by the core_auth_request_password_rest WS.

Parameters

array $data array containing the data to be validated (email and username)

Return values

array array of errors compatible with mform

Since: Moodle 3.4

◆ core_myprofile_navigation()

core_myprofile_navigation	(	core_user\output\myprofile\tree	$tree,
			$user,
			$iscurrentuser,
			$course )

Defines core nodes for my profile navigation tree.

Parameters

core_user\output\myprofile\tree	$tree	Tree object
stdClass	$user	user object
bool	$iscurrentuser	is the user viewing profile, current user ?
stdClass	$course	course object

Return values

bool

◆ core_question_find_next_unused_idnumber()

core_question_find_next_unused_idnumber	(	?string	$oldidnumber,
		int	$categoryid )

If $oldidnumber ends in some digits then return the next available idnumber of the same form.

So idnum -> null (no digits at the end) idnum0099 -> idnum0100 (if that is unused, else whichever of idnum0101, idnume0102, ... is unused. idnum9 -> idnum10.

Parameters

string \| null	$oldidnumber	a question idnumber, or can be null.
int	$categoryid	a question category id.

Return values

string|null suggested new idnumber for a question in that category, or null if one cannot be found.

◆ core_question_question_preview_pluginfile()

core_question_question_preview_pluginfile	(	$previewcontext,
		$questionid,
		$filecontext,
		$filecomponent,
		$filearea,
		$args,
		$forcedownload,
		$options = [] )

Serve questiontext files in the question text when they are displayed in this report.

Parameters

context	$previewcontext	the context in which the preview is happening.
int	$questionid	the question id.
context	$filecontext	the file (question) context.
string	$filecomponent	the component the file belongs to.
string	$filearea	the file area.
array	$args	remaining file args.
bool	$forcedownload
array	$options	additional options affecting the file serving.

◆ core_tables_exist()

core_tables_exist ( )

Checks if the main tables have been installed yet or not.

Note: we can not use caches here because they might be stale, use with care!

Return values

bool

◆ count_enrolled_users()

count_enrolled_users	(	context	$context,
			$withcapability = '',
			$groupids = 0,
			$onlyactive = false )

Counts list of users enrolled into course (as per above function)

Parameters

context	$context
string	$withcapability
int \| array	$groupids	The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions

Return values

int	number of users enrolled into course

◆ count_letters()

count_letters	(		$string,
			$format = null )

Count letters in a string.

Letters are defined as chars not in tags and different from whitespace.

Parameters

string	$string	The text to be searched for letters. May be HTML.
int \| null	$format

Return values

int	The count of letters in the specified text.

◆ count_login_failures()

count_login_failures ( )

Deprecated: since Moodle 2.7, use user_count_login_failures() instead.

◆ count_words()

count_words	(		$string,
			$format = null )

Count words in a string.

Words are defined as things between whitespace.

Parameters

string	$string	The text to be searched for words. May be HTML.
int \| null	$format

Return values

int	The count of words in the specified string

◆ course_category_hide()

course_category_hide ( )

Deprecated: since 2.5

◆ course_category_show()

course_category_show ( )

Deprecated: since 2.5

◆ course_get_cm_rename_action()

course_get_cm_rename_action ( )

Deprecated: since 3.1

◆ course_scale_used()

course_scale_used ( )

Deprecated: since Moodle 3.1

◆ coursemodule_visible_for_user()

coursemodule_visible_for_user ( )

Deprecated: Since Moodle 2.7 MDL-44070

◆ coursetag_delete_course_tags()

coursetag_delete_course_tags ( )

Deprecated: since 3.0

◆ coursetag_delete_keyword()

coursetag_delete_keyword ( )

Deprecated: since 3.0

◆ coursetag_get_all_tags()

coursetag_get_all_tags ( )

Deprecated: since 3.0

◆ coursetag_get_jscript()

coursetag_get_jscript ( )

Deprecated: since 3.0

◆ coursetag_get_jscript_links()

coursetag_get_jscript_links ( )

Deprecated: since 3.0

◆ coursetag_get_records()

coursetag_get_records ( )

Deprecated: since 3.0

◆ coursetag_get_tagged_courses()

coursetag_get_tagged_courses ( )

Deprecated: since 3.0

◆ coursetag_get_tags()

coursetag_get_tags ( )

Deprecated: since 3.0

◆ coursetag_store_keywords()

coursetag_store_keywords ( )

Deprecated: since 3.0

◆ create_contexts()

create_contexts ( )

Deprecated: since 2.2

◆ create_course_category()

create_course_category ( )

Deprecated: since 2.5

◆ create_user_key()

create_user_key	(	$script,
		$userid,
		$instance = null,
		$iprestriction = null,
		$validuntil = null )

Creates a new private user access key.

Parameters

string	$script	unique target identifier
int	$userid
int	$instance	optional instance id
string	$iprestriction	optional ip restricted access
int	$validuntil	key valid only until given data

Return values

string access key value

◆ create_user_record()

create_user_record	(	$username,
		$password,
		$auth = 'manual' )

Creates a bare-bones user record.

Todo: Outline auth types and provide code example

Parameters

string	$username	New user's username to add to record
string	$password	New user's password to add to record
string	$auth	Form of authentication required

Return values

stdClass A complete user object

◆ cron_bc_hack_plugin_functions()

cron_bc_hack_plugin_functions	(		$plugintype,
			$plugins )

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.)

Parameters

string	$plugintype	Plugin type e.g. 'report'
array	$plugins	Array from plugin name (e.g. 'report_frog') to function name (e.g. 'report_frog_cron') for plugin cron functions that were already found using the new API

Return values

array Revised version of $plugins that adds in any extra plugin functions found by looking in the older location

Deprecated: since Moodle 3.9 MDL-52846. Please use new task API.

Todo: MDL-61165 This will be deleted in Moodle 4.1.

◆ cron_execute_plugin_type()

cron_execute_plugin_type	(		$plugintype,
			$description = null )

Executes cron functions for a specific type of plugin.

Parameters

string	$plugintype	Plugin type (e.g. 'report')
string	$description	If specified, will display 'Starting (whatever)' and 'Finished (whatever)' lines, otherwise does not display

Deprecated: since Moodle 3.9 MDL-52846. Please use new task API.

Todo: MDL-61165 This will be deleted in Moodle 4.1.

◆ cron_prepare_core_renderer()

cron_prepare_core_renderer ( $restore = false )

Prepare the output renderer for the cron run.

This involves creating a new $PAGE, and $OUTPUT fresh for each task and prevents any one task from influencing any other.

Parameters

bool $restore Whether to restore the original PAGE and OUTPUT

Deprecated: since 4.2 Use core\cron\prepare_core_renderer() instead.

◆ cron_run()

cron_run ( ?int $keepalive = null )

Execute cron tasks.

Parameters

int | null $keepalive The keepalive time for this cron run.

Deprecated: since 4.2 Use core\cron\run_main_process() instead.

◆ cron_run_adhoc_tasks()

cron_run_adhoc_tasks	(	int	$timenow,
			$keepalive = 0,
			$checklimits = true )

Execute all queued adhoc tasks, applying necessary concurrency limits and time limits.

Parameters

int	$timenow	The time this process started.
int	$keepalive	Keep this function alive for N seconds and poll for new adhoc tasks.
bool	$checklimits	Should we check limits?

Deprecated: since 4.2 Use core\cron\run_adhoc_tasks() instead.

◆ cron_run_inner_adhoc_task()

cron_run_inner_adhoc_task ( \core\task\adhoc_task $task )

Shared code that handles running of a single adhoc task within the cron.

Parameters

core\task\adhoc_task $task

Deprecated: since 4.2 Use core\cron\run_inner_adhoc_task() instead.

◆ cron_run_inner_scheduled_task()

cron_run_inner_scheduled_task ( \core\task\task_base $task )

Shared code that handles running of a single scheduled task within the cron.

Not intended for calling directly outside of this library!

Parameters

core\task\task_base $task

Deprecated: since 4.2 Use core\cron\run_inner_scheduled_task() instead.

◆ cron_run_scheduled_tasks()

cron_run_scheduled_tasks ( int $timenow )

Execute all queued scheduled tasks, applying necessary concurrency limits and time limits.

Parameters

int $timenow The time this process started.

Deprecated: since 4.2 Use core\cron\run_scheduled_tasks() instead.

◆ cron_run_single_task()

cron_run_single_task ( )

Deprecated: since Moodle 3.9 MDL-63580. Please use the core\task\manager\run_from_cli($task).

◆ cron_set_process_title()

cron_set_process_title ( string $title )

Sets the process title.

This makes it very easy for a sysadmin to immediately see what task a cron process is running at any given moment.

Parameters

string $title process status title

Deprecated: since 4.2 Use core\cron\set_process_title() instead.

◆ cron_setup_user()

cron_setup_user	(	$user = null,
		$course = null,
		$leavepagealone = false )

Sets up current user and course environment (lang, etc.) in cron.

Do not use outside of cron script!

Parameters

stdClass	$user	full user object, null means default cron user (admin), value 'reset' means reset internal static caches.
stdClass	$course	full course record, null means $SITE
bool	$leavepagealone	If specified, stops it messing with global page object

Deprecated: since 4.2. Use core\core\setup_user() instead.

Return values

void

◆ cron_trace_time_and_memory()

cron_trace_time_and_memory ( )

Output some standard information during cron runs.

Specifically current time and memory usage. This method also does gc_collect_cycles() (before displaying memory usage) to try to help PHP manage memory better.

Deprecated: since 4.2 Use core\cron\trace_time_and_memory() instead.

◆ css_is_colour()

css_is_colour ( )

Deprecated: since Moodle 3.2

◆ css_is_width()

css_is_width ( )

Deprecated: since Moodle 3.2

◆ css_minify_css()

css_minify_css ( )

Deprecated: since 2.6

◆ css_send_cached_css()

css_send_cached_css	(		$csspath,
			$etag )

Sends a cached CSS file.

This function sends the cached CSS file. Remember it is generated on the first request, then optimised/minified, and finally cached for serving.

Parameters

string	$csspath	The path to the CSS file we want to serve.
string	$etag	The revision to make sure we utilise any caches.

◆ css_send_cached_css_content()

css_send_cached_css_content	(		$csscontent,
			$etag )

Sends a cached CSS content.

Parameters

string	$csscontent	The actual CSS markup.
string	$etag	The revision to make sure we utilise any caches.

◆ css_send_temporary_css()

css_send_temporary_css ( $css )

Sends CSS directly and disables all caching.

The Content-Length of the body is also included, but the script is not ended.

Parameters

string $css The CSS content to send

◆ css_send_uncached_css()

css_send_uncached_css ( $css )

Sends CSS directly without caching it.

This function takes a raw CSS string, optimises it if required, and then serves it. Turning both themedesignermode and CSS optimiser on at the same time is awful for performance because of the optimiser running here. However it was done so that theme designers could utilise the optimised output during development to help them optimise their CSS... not that they should write lazy CSS.

Parameters

string $css

◆ css_send_unmodified()

css_send_unmodified	(		$lastmodified,
			$etag )

Send file not modified headers.

Parameters

int	$lastmodified
string	$etag

◆ css_sort_by_count()

css_sort_by_count ( )

Deprecated: since Moodle 3.2

◆ css_store_css()

if(!defined('THEME_DESIGNER_CACHE_LIFETIME')) css_store_css	(	theme_config	$theme,
			$csspath,
			$csscontent )

Stores CSS in a file at the given path.

This function either succeeds or throws an exception.

Parameters

theme_config	$theme	The theme that the CSS belongs to.
string	$csspath	The path to store the CSS at.
string	$csscontent	the complete CSS in one string.

◆ css_write_file()

css_write_file	(		$filename,
			$content )

Writes a CSS file.

Parameters

string	$filename
string	$content

◆ current_language()

current_language ( )

Returns the code for the current language.

Return values

string

◆ current_theme()

current_theme ( )

Deprecated: use $PAGE->theme->name instead.

◆ custom_script_path()

custom_script_path ( )

Detect a custom script replacement in the data directory that will replace an existing moodle script.

Return values

string|bool full path name if a custom script exists, false if no custom script exists

◆ data_submitted()

data_submitted ( )

Determine if there is data waiting to be processed from a form.

Used on most forms in Moodle to check for data Returns the data as an object, if it's found. This object can be used in foreach loops without casting because it's cast to (array) automatically

Checks that submitted POST data exists and returns it as object.

Return values

mixed false or object

◆ date_format_string()

date_format_string	(	$date,
		$format,
		$tz = 99 )

Returns a formatted date ensuring it is UTF-8.

If we are running under Windows convert to Windows encoding and then back to UTF-8 (because it's impossible to specify UTF-8 to fetch locale info in Win32).

Parameters

int	$date	the timestamp - since Moodle 2.9 this is a real UTC timestamp
string	$format	strftime format.
int \| float \| string	$tz	the user timezone

Return values

string the formatted date/time.

Since: Moodle 2.3.3

◆ dayofweek()

dayofweek	(	$day,
		$month,
		$year )

Calculate the position in the week of a specific calendar day.

Parameters

int	$day	The day of the date whose position in the week is sought
int	$month	The month of the date whose position in the week is sought
int	$year	The year of the date whose position in the week is sought

Return values

int

◆ days_in_month()

days_in_month	(		$month,
			$year )

Calculate the number of days in a given month.

Parameters

int	$month	The month whose day count is sought
int	$year	The year of the month whose day count is sought

Return values

int

◆ db_replace()

db_replace	(	$search,
		$replace,
		$additionalskiptables = '' )

Moved from admin/replace.php so that we can use this in cron.

Parameters

string	$search	string to look for
string	$replace	string to replace

Return values

bool	success or fail

◆ db_should_replace()

db_should_replace	(	$table,
		$column = '',
		$additionalskiptables = '' )

Given a table and optionally a column name should replaces be done?

Parameters

string	$table	name
string	$column	name

Return values

bool	success or fail

◆ debugging()

debugging	(	$message = '',
		$level = DEBUG_NORMAL,
		$backtrace = null )

Standard Debugging Function.

Returns true if the current site debugging settings are equal or above specified level. If passed a parameter it will emit a debugging notice similar to trigger_error(). The routing of notices is controlled by $CFG->debugdisplay eg use like this:

1) debugging('a normal debug notice'); 2) debugging('something really picky', DEBUG_ALL); 3) debugging('annoying debug message only for developers', DEBUG_DEVELOPER); 4) if (debugging()) { perform extra debugging operations (do not use print or echo) }

In code blocks controlled by debugging() (such as example 4) any output should be routed via debugging() itself, or the lower-level trigger_error() or error_log(). Using echo or print will break XHTML JS and HTTP headers.

It is also possible to define NO_DEBUG_DISPLAY which redirects the message to error_log.

Parameters

string	$message	a message to print
int	$level	the level at which this debugging statement should show
array	$backtrace	use different backtrace

Return values

bool

◆ decompose_update_into_safe_changes()

decompose_update_into_safe_changes	(	array	$newvalues,
			$unusedvalue )

Helper used by update_field_with_unique_index().

Given a desired set of changes, break them down into single udpates that can be done one at a time without breaking any unique index constraints.

Suppose the input is array(1 => 2, 2 => 1) and -1. Then the output will be array (array(1, -1), array(2, 1), array(-1, 2)). This function solves this problem in the general case, not just for simple swaps. The unit tests give more examples.

Note that, it is the responsibility of the caller to make sure that the requested rename is legal. For example, if you ask for something impossible like array(1 => 2, 2 => 2) then the results are undefined. (You will probably get a unique key violation error from the database later.)

Parameters

array	$newvalues	The desired re-ordering. E.g. array(1 => 4, 2 => 1, 3 => 3, 4 => 2).
int	$unusedvalue	A value that is not currently used.

Return values

array A safe way to perform the re-order. An array of two-element arrays array($from, $to). E.g. array(array(1, -1), array(2, 1), array(4, 2), array(-1, 4)).

◆ dedupe_user_access()

dedupe_user_access ( )

Deprecated: since Moodle 3.4 and removed immediately. MDL-49398.

◆ default_error_handler()

default_error_handler	(	$errno,
		$errstr,
		$errfile,
		$errline )

Default error handler, prevents some white screens.

Parameters

int	$errno
string	$errstr
string	$errfile
int	$errline

Return values

bool	false means use default error handler

◆ default_exception_handler()

default_exception_handler ( $ex )

Default exception handler.

Parameters

Exception $ex

Return values

void	-does not return. Terminates execution!

◆ default_page_type_list()

default_page_type_list	(	$pagetype,
		$parentcontext = null,
		$currentcontext = null )

Generates a default page type list when a more appropriate callback cannot be decided upon.

Parameters

string	$pagetype
stdClass	$parentcontext
stdClass	$currentcontext

Return values

array

◆ delete_context()

delete_context ( )

Deprecated: since Moodle 2.2

◆ delete_course()

delete_course	(		$courseorid,
			$showfeedback = true )

Delete a course, including all related data from the database, and any associated files.

Parameters

mixed	$courseorid	The id of the course or course object to delete.
bool	$showfeedback	Whether to display notifications of each action the function performs.

Return values

bool	true if all the removals succeeded. false if there were any failures. If this method returns false, some of the removals will probably have succeeded, and others failed, but you have no way of knowing which.

◆ delete_course_module()

delete_course_module ( )

Deprecated: since 2.5

◆ delete_event()

delete_event ( )

Deprecated: please use calendar_event->delete() instead.

◆ delete_question_bank_entry()

delete_question_bank_entry ( $entryid )

Check if there is more versions left for the entry.

If not delete the entry.

Parameters

int $entryid

◆ delete_user()

delete_user ( stdClass $user )

Marks user deleted in internal user database and notifies the auth plugin.

Also unenrols user from all roles and does other cleanup.

Any plugin that needs to purge user data should register the 'user_deleted' event.

Parameters

stdClass $user full user object before delete

Return values

boolean success

Exceptions

coding_exception if invalid $user parameter detected

◆ delete_user_key()

delete_user_key	(		$script,
			$userid )

Delete the user's new private user access keys for a particular script.

Parameters

string	$script	unique target identifier
int	$userid

Return values

void

◆ detect_munged_arguments()

detect_munged_arguments ( )

Deprecated: use clean_param($string, PARAM_FILE) instead.

◆ display_auth_lock_options()

display_auth_lock_options	(	$settings,
		$auth,
		$userfields,
		$helptext,
		$mapremotefields,
		$updateremotefields,
		$customfields = array() )

Helper function used to print locking for auth plugins on admin pages.

Parameters

admin_settingpage	$settings	Moodle admin settings instance
string	$auth	authentication plugin shortname
array	$userfields	user profile fields
string	$helptext	help text to be displayed at top of form
boolean	$mapremotefields	Map fields or lock only.
boolean	$updateremotefields	Allow remote updates
array	$customfields	list of custom profile fields

Since: Moodle 3.3

◆ display_size()

display_size	(		$size,
		int	$decimalplaces = 1,
		string	$fixedunits = '' )

Converts bytes into display form.

Parameters

int	$size	The size to convert to human readable form
int	$decimalplaces	If specified, uses fixed number of decimal places
string	$fixedunits	If specified, uses fixed units (e.g. 'KB')

Return values

string Display version of size

◆ dndupload_add_to_course()

dndupload_add_to_course	(		$course,
			$modnames )

Add the Javascript to enable drag and drop upload to a course page.

Parameters

object	$course	The currently displayed course
array	$modnames	The list of enabled (visible) modules on this site

Return values

void

◆ download_as_dataformat()

download_as_dataformat	(	$filename,
		$dataformat,
		$columns,
		$iterator,
		$callback = null )

Sends a formated data file to the browser.

@subpackage dataformat

Parameters

string	$filename	The base filename without an extension
string	$dataformat	A dataformat name
array	$columns	An ordered map of column keys and labels
Iterator	$iterator	An iterator over the records, usually a RecordSet
callable	$callback	An option function applied to each record before writing

Exceptions

Deprecated: since Moodle 3.9 - MDL-68500 please use core\dataformat\download_data

◆ draw_rand_array()

draw_rand_array	(		$array,
			$draws )

Given an arbitrary array, and a number of draws, this function returns an array with that amount of items.

The indexes are retained.

Todo: Finish documenting this function

Parameters

array	$array
int	$draws

Return values

array

◆ drop_plugin_tables()

drop_plugin_tables	(	$name,
		$file,
		$feedback = true )

Delete all plugin tables.

Parameters

string	$name	Name of plugin, used as table prefix
string	$file	Path to install.xml file
bool	$feedback	defaults to true

Return values

bool	Always returns true

◆ dst_changes_for_year()

dst_changes_for_year ( )

Deprecated: since Moodle 2.9

◆ dst_offset_on()

dst_offset_on	(		$time,
			$strtimezone = null )

Calculates the Daylight Saving Offset for a given date/time (timestamp)

Note: Daylight saving only works for string timezones and not for float.

Parameters

int	$time	must NOT be compensated at all, it has to be a pure timestamp
int \| float \| string	$strtimezone	user timezone

Return values

int

◆ during_initial_install()

during_initial_install ( )

Indicates whether we are in the middle of the initial Moodle install.

Very occasionally it is necessary avoid running certain bits of code before the Moodle installation has completed. The installed flag is set in admin/index.php after Moodle core and all the plugins have been installed, but just before the person doing the initial install is asked to choose the admin password.

Return values

boolean true if the initial install is not complete.

◆ editors_get_available()

editors_get_available ( )

Get the list of available editors.

Return values

array Array ('editorname'=>'localised editor name')

◆ editors_get_enabled()

editors_get_enabled ( )

Returns list of enabled text editors.

Return values

array of name=>texteditor

◆ editors_get_preferred_editor()

editors_get_preferred_editor ( $format = NULL )

Returns users preferred editor for given format.

Parameters

int $format text format or null of none

Return values

texteditor object

◆ editors_get_preferred_format()

editors_get_preferred_format ( )

Returns users preferred text format.

Return values

int	standard text format

◆ editors_head_setup()

editors_head_setup ( )

Setup all JS and CSS needed for editors.

Return values

void

◆ email_is_not_allowed()

email_is_not_allowed ( $email )

Check that an email is allowed.

It returns an error message if there was a problem.

Parameters

string $email Content of email

Return values

string|false

◆ email_should_be_diverted()

email_should_be_diverted ( $email )

A helper function to test for email diversion.

Parameters

string $email

Return values

bool	Returns true if the email should be diverted

◆ email_to_user()

email_to_user	(	$user,
		$from,
		$subject,
		$messagetext,
		$messagehtml = '',
		$attachment = '',
		$attachname = '',
		$usetrueaddress = true,
		$replyto = '',
		$replytoname = '',
		$wordwrapwidth = 79 )

Send an email to a specified user.

Parameters

stdClass	$user	A $USER object
stdClass	$from	A $USER object
string	$subject	plain text subject line of the email
string	$messagetext	plain text version of the message
string	$messagehtml	complete html version of the message (optional)
string	$attachment	a file on the filesystem, either relative to $CFG->dataroot or a full path to a file in one of the following directories: $CFG->cachedir, $CFG->dataroot, $CFG->dirroot, $CFG->localcachedir, $CFG->tempdir
string	$attachname	the name of the file (extension indicates MIME)
bool	$usetrueaddress	determines whether $from email address should be sent out. Will be overruled by user profile setting for maildisplay
string	$replyto	Email address to reply to
string	$replytoname	Name of reply to recipient
int	$wordwrapwidth	custom word wrap width, default 79

Return values

bool	Returns true if mail was sent OK and false if there was an error.

◆ endecrypt()

endecrypt	(	$pwd,
		$data,
		$case )

Based on a class by Mukul Sabharwal [mukulsabharwal @ yahoo.com].

Todo: Finish documenting this function

Parameters

string	$pwd	The password to use when encrypting or decrypting
string	$data	The data to be decrypted/encrypted
string	$case	Either 'de' for decrypt or '' for encrypt

Return values

string

◆ enrol_accessing_via_instance()

enrol_accessing_via_instance ( stdClass $instance )

Is current user accessing course via this enrolment method?

This is intended for operations that are going to affect enrol instances.

Parameters

stdClass $instance enrol instance

Return values

bool

◆ enrol_add_course_navigation()

enrol_add_course_navigation	(	navigation_node	$coursenode,
			$course )

Add navigation nodes.

Parameters

navigation_node	$coursenode
object	$course

Return values

void

◆ enrol_calculate_duration()

enrol_calculate_duration	(		$timestart,
			$timeend )

Calculate duration base on start time and end time.

Parameters

int	$timestart	Time start
int	$timeend	Time end

Return values

float|int Calculated duration

◆ enrol_check_plugins()

enrol_check_plugins	(		$user,
		bool	$ignoreintervalcheck = true )

Check all the login enrolment information for the given user object by querying the enrolment plugins This function may be very slow, use only once after log-in or login-as.

Parameters

stdClass	$user	User object.
bool	$ignoreintervalcheck	Force to ignore checking configured sync intervals.

Return values

void

◆ enrol_cohort_can_view_cohort()

enrol_cohort_can_view_cohort ( )

Deprecated: since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()

◆ enrol_cohort_enrol_all_users()

enrol_cohort_enrol_all_users ( )

Deprecated: since Moodle 2.8 MDL-35618 this functionality is removed

◆ enrol_cohort_get_cohorts()

enrol_cohort_get_cohorts ( )

Deprecated: since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed

◆ enrol_cohort_search_cohorts()

enrol_cohort_search_cohorts ( )

Deprecated: since Moodle 2.8 MDL-35618 this functionality is removed

◆ enrol_course_delete()

enrol_course_delete	(		$course,
			$userid = null )

Called when course is about to be deleted.

If a user id is passed, only enrolments that the user has permission to un-enrol will be removed, otherwise all enrolments in the course will be removed.

Parameters

stdClass	$course
int \| null	$userid

Return values

void

◆ enrol_course_edit_form()

enrol_course_edit_form	(	MoodleQuickForm	$mform,
			$data,
			$context )

This function adds necessary enrol plugins UI into the course edit form.

Parameters

MoodleQuickForm	$mform
object	$data	course edit form data
object	$context	context of existing course or parent category if course does not exist

Return values

void

◆ enrol_course_edit_validation()

enrol_course_edit_validation	(	array	$data,
			$context )

Validate course edit form data.

Parameters

array	$data	raw form data
object	$context	context of existing course or parent category if course does not exist

Return values

array errors array

◆ enrol_course_updated()

enrol_course_updated	(	$inserted,
		$course,
		$data )

Update enrol instances after course edit form submission.

Parameters

bool	$inserted	true means new course added, false course already existed
object	$course
object	$data	form data

Return values

void

◆ enrol_get_all_users_courses()

enrol_get_all_users_courses	(	$userid,
		$onlyactive = false,
		$fields = null,
		$sort = null )

Returns list of courses user is enrolled into without performing any capability checks.

The $fields param is a list of field names to ADD so name just the fields you really need, which will be added and uniq'd.

Parameters

int	$userid	User whose courses are returned, defaults to the current user.
bool	$onlyactive	Return only active enrolments in courses user may see.
string \| array	$fields	Extra fields to be returned (array or comma-separated list).
string \| null	$sort	Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort.

Return values

array

◆ enrol_get_course_by_user_enrolment_id()

enrol_get_course_by_user_enrolment_id ( $ueid )

Returns the course where a user enrolment belong to.

Parameters

int $ueid user_enrolments id

Return values

stdClass

◆ enrol_get_course_description_texts()

enrol_get_course_description_texts ( $course )

Returns course enrolment detailed information.

Parameters

object $course

Return values

array of html fragments - can be used to construct lists

◆ enrol_get_course_info_icons()

enrol_get_course_info_icons	(		$course,
		array	$instances = NULL )

Returns course enrolment information icons.

Parameters

object	$course
array	$instances	enrol instances of this course, improves performance

Return values

array of pix_icon

◆ enrol_get_course_users()

enrol_get_course_users	(	$courseid = false,
		$onlyactive = false,
		$usersfilter = [],
		$uefilter = [],
		$usergroups = [] )

Return all users enrolled in a course.

Parameters

int	$courseid	Course id or false if using $uefilter (user enrolment ids may belong to different courses)
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions
array	$usersfilter	Limit the results obtained to this list of user ids. $uefilter compatibility not guaranteed.
array	$uefilter	Limit the results obtained to this list of user enrolment ids. $usersfilter compatibility not guaranteed.
array	$usergroups	Limit the results of users to the ones that belong to one of the submitted group ids.

Return values

stdClass[]

◆ enrol_get_course_users_roles()

enrol_get_course_users_roles ( int $courseid )

Returns list of roles per users into course.

Parameters

int $courseid Course id.

Return values

array Array[$userid][$roleid] = role_assignment.

◆ enrol_get_courses_sortingsql()

enrol_get_courses_sortingsql ( $sort = null )

Returns SQL ORDER arguments which reflect the admin settings to sort my courses.

Parameters

string | null $sort SQL ORDER arguments which were originally requested (optionally).

Return values

string SQL ORDER arguments.

◆ enrol_get_enrolment_end()

enrol_get_enrolment_end	(		$courseid,
			$userid )

This function returns the end of current active user enrolment.

It deals correctly with multiple overlapping user enrolments.

Parameters

int	$courseid
int	$userid

Return values

int|bool timestamp when active enrolment ends, false means no active enrolment now, 0 means never

◆ enrol_get_instances()

enrol_get_instances	(		$courseid,
			$enabled )

Returns enrolment instances in given course.

Parameters

int	$courseid
bool	$enabled

Return values

array of enrol instances

◆ enrol_get_my_courses()

enrol_get_my_courses	(	$fields = null,
		$sort = null,
		$limit = 0,
		$courseids = [],
		$allaccessible = false,
		$offset = 0,
		$excludecourses = [] )

Returns list of courses current $USER is enrolled in and can access.

The $fields param is a list of field names to ADD so name just the fields you really need, which will be added and uniq'd.

If $allaccessible is true, this will additionally return courses that the current user is not enrolled in, but can access because they are open to the user for other reasons (course view permission, currently viewing course as a guest, or course allows guest access without password).

Parameters

string \| array	$fields	Extra fields to be returned (array or comma-separated list).
string \| null	$sort	Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort. Allowed prefixes for sort fields are: "ul" for the user_lastaccess table, "c" for the courses table, "ue" for the user_enrolments table.
int	$limit	max number of courses
array	$courseids	the list of course ids to filter by
bool	$allaccessible	Include courses user is not enrolled in, but can access
int	$offset	Offset the result set by this number
array	$excludecourses	IDs of hidden courses to exclude from search

Return values

array

◆ enrol_get_period_list()

enrol_get_period_list ( )

Get the list of options for the enrolment period dropdown.

Return values

array List of options for the enrolment period dropdown

◆ enrol_get_plugin()

enrol_get_plugin ( $name )

Returns instance of enrol plugin.

Parameters

string $name name of enrol plugin ('manual', 'guest', ...)

Return values

enrol_plugin

◆ enrol_get_plugins()

enrol_get_plugins ( $enabled )

Returns instances of enrol plugins.

Parameters

bool $enabled return enabled only

Return values

array of enrol plugins name=>instance

◆ enrol_get_shared_courses()

moodle_database enrol_get_shared_courses	(	$user1,
		$user2,
		$preloadcontexts = false,
		$checkexistsonly = false )

Returns any courses shared by the two users.

The courses has to be visible and enrolments has to be active, timestart and timeend restrictions are ignored.

$DB

Parameters

stdClass \| int	$user1
stdClass \| int	$user2
bool	$preloadcontexts	If set to true contexts for the returned courses will be preloaded.
bool	$checkexistsonly	If set to true then this function will return true if the users share any courses and false if not.

Return values

array|bool An array of courses that both users are enrolled in OR if $checkexistsonly set returns true if the users share any courses and false if not.

◆ enrol_get_users_courses()

enrol_get_users_courses	(	$userid,
		$onlyactive = false,
		$fields = null,
		$sort = null )

Returns list of courses user is enrolled into.

Note: Use enrol_get_all_users_courses() if you need the list without any capability checks.

The $fields param is a list of field names to ADD so name just the fields you really need, which will be added and uniq'd.

Parameters

int	$userid	User whose courses are returned, defaults to the current user.
bool	$onlyactive	Return only active enrolments in courses user may see.
string \| array	$fields	Extra fields to be returned (array or comma-separated list).
string \| null	$sort	Comma separated list of fields to sort by, defaults to respecting navsortmycoursessort.

Return values

array

◆ enrol_is_enabled()

enrol_is_enabled ( $enrol )

Checks if a given plugin is in the list of enabled enrolment plugins.

Parameters

string $enrol Enrolment plugin name

Return values

boolean Whether the plugin is enabled

◆ enrol_output_fragment_user_enrolment_form()

enrol_output_fragment_user_enrolment_form ( $args )

Serve the user enrolment form as a fragment.

Parameters

array $args List of named arguments for the fragment loader.

Return values

string

◆ enrol_selfenrol_available()

enrol_selfenrol_available ( $courseid )

Is there a chance users might self enrol.

Parameters

int $courseid

Return values

bool

◆ enrol_send_welcome_email_options()

enrol_send_welcome_email_options ( )

Send welcome email "from" options.

Return values

array list of from options

◆ enrol_sharing_course()

enrol_sharing_course	(		$user1,
			$user2 )

Do these two students share any course?

The courses has to be visible and enrolments has to be active, timestart and timeend restrictions are ignored.

This function calls {

See also: enrol_get_shared_courses()} setting checkexistsonly to true.

Parameters

stdClass \| int	$user1
stdClass \| int	$user2

Return values

bool

◆ enrol_try_internal_enrol()

enrol_try_internal_enrol	(	$courseid,
		$userid,
		$roleid = null,
		$timestart = 0,
		$timeend = 0 )

Try to enrol user via default internal auth plugin.

For now this is always using the manual enrol plugin...

Parameters

$courseid
$userid
$roleid
$timestart
$timeend

Return values

bool success

◆ enrol_user_delete()

enrol_user_delete ( $user )

Called when user is about to be deleted.

Parameters

object $user

Return values

void

◆ enrol_user_sees_own_courses()

enrol_user_sees_own_courses ( $user = null )

Can user access at least one enrolled course?

Cheat if necessary, but find out as fast as possible!

Parameters

int | stdClass $user null means use current user

Return values

bool

◆ environment_check()

object environment_check	(		$version,
			$env_select )

This function will check for everything (DB, PHP and PHP extensions for now) returning an array of environment_result objects.

Parameters

string	$version	xml version we are going to use to test this server
int	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use.

Return values

environment_results[] array of results encapsulated in one environment_result object

◆ environment_check_database()

environment_check_database	(		$version,
			$env_select )

This function will check if database requirements are satisfied.

@uses NO_VERSION_DATA_FOUND @uses NO_DATABASE_SECTION_FOUND @uses NO_DATABASE_VENDORS_FOUND @uses NO_DATABASE_VENDOR_MYSQL_FOUND @uses NO_DATABASE_VENDOR_POSTGRES_FOUND @uses NO_DATABASE_VENDOR_VERSION_FOUND

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

object results encapsulated in one environment_result object

◆ environment_check_moodle()

environment_check_moodle	(		$version,
			$env_select )

This function will check if Moodle requirements are satisfied.

@uses NO_VERSION_DATA_FOUND

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

object results encapsulated in one environment_result object

◆ environment_check_pcre_unicode()

environment_check_pcre_unicode	(		$version,
			$env_select )

Looks for buggy PCRE implementation, we need unicode support in Moodle...

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

stdClass results encapsulated in one environment_result object, null if irrelevant

◆ environment_check_php()

environment_check_php	(		$version,
			$env_select )

This function will check if php requirements are satisfied.

@uses NO_VERSION_DATA_FOUND @uses NO_PHP_SECTION_FOUND @uses NO_PHP_VERSION_FOUND

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

object results encapsulated in one environment_result object

◆ environment_check_php_extensions()

environment_check_php_extensions	(		$version,
			$env_select )

This function will check if php extensions requirements are satisfied.

@uses NO_VERSION_DATA_FOUND @uses NO_PHP_EXTENSIONS_SECTION_FOUND @uses NO_PHP_EXTENSIONS_NAME_FOUND

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

array array of results encapsulated in one environment_result object

◆ environment_check_php_settings()

environment_check_php_settings	(		$version,
			$env_select )

This function will check if php extensions requirements are satisfied.

@uses NO_VERSION_DATA_FOUND @uses NO_PHP_SETTINGS_NAME_FOUND

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

array array of results encapsulated in one environment_result object

◆ environment_check_unicode()

environment_check_unicode	(		$version,
			$env_select )

This function will check if unicode database requirements are satisfied.

@uses NO_VERSION_DATA_FOUND @uses NO_UNICODE_SECTION_FOUND

Parameters

string	$version	xml version we are going to use to test this server
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

object results encapsulated in one environment_result object

◆ environment_custom_checks()

environment_custom_checks	(		$version,
			$env_select )

This function will do the custom checks.

@uses CUSTOM_CHECK_FUNCTION_MISSING @uses CUSTOM_CHECK_FILE_MISSING @uses NO_CUSTOM_CHECK_FOUND

Parameters

string	$version	xml version we are going to use to test this server.
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

array array of results encapsulated in environment_result objects.

◆ environment_get_errors()

environment_get_errors ( $environment_results )

Returns array of critical errors in plain text format.

Parameters

array $environment_results array of results gathered

Return values

array errors

◆ environment_verify_plugin()

environment_verify_plugin	(		$plugin,
			$pluginxml )

Checks if a plugin tag has a name attribute and it matches the plugin being tested.

Parameters

string	$plugin	the name of the plugin.
array	$pluginxml	the xmlised structure for the plugin tag being tested.

Return values

boolean true if the name attribute exists and matches the plugin being tested.

◆ error()

error ( )

Deprecated: since 2.0

◆ events_cleanup()

events_cleanup ( )

Deprecated: since Moodle 3.6. Please use the Events 2 API.

◆ events_cron()

events_cron ( )

Deprecated: since Moodle 3.1

◆ events_dequeue()

events_dequeue ( )

Deprecated: since Moodle 3.6. Please use the Events 2 API.

◆ events_dispatch()

events_dispatch ( )

Deprecated: since Moodle 3.1

◆ events_get_cached()

events_get_cached ( )

Deprecated: since Moodle 3.6. Please use the Events 2 API.

◆ events_get_handlers()

events_get_handlers ( )

Deprecated: since Moodle 3.6. Please use the Events 2 API.

◆ events_is_registered()

events_is_registered ( )

Deprecated: since Moodle 3.1

◆ events_load_def()

events_load_def ( )

Deprecated: since Moodle 3.1

◆ events_pending_count()

events_pending_count ( )

Deprecated: since Moodle 3.1

◆ events_process_queued_handler()

events_process_queued_handler ( )

Deprecated: since Moodle 3.1

◆ events_queue_handler()

events_queue_handler ( )

Deprecated: since Moodle 3.1

◆ events_trigger()

events_trigger ( )

Deprecated: since 2.6

◆ events_trigger_legacy()

events_trigger_legacy ( )

Deprecated: since Moodle 3.1

◆ events_uninstall()

events_uninstall ( )

Deprecated: since Moodle 3.6. Please use the Events 2 API.

◆ events_update_definition()

events_update_definition ( )

Deprecated: since Moodle 3.1

◆ exists_auth_plugin()

exists_auth_plugin ( $auth )

Returns whether a given authentication plugin exists.

Parameters

string $auth Form of authentication to check for. Defaults to the global setting in $CFG.

Return values

boolean Whether the plugin is available.

◆ external_function_info()

external_function_info ( )

Deprecated: since Moodle 3.1. Use external_api\external_function_info().

◆ external_update_descriptions()

external_update_descriptions ( $component )

Web service discovery function used during install and upgrade.

Parameters

string $component name of component (moodle, etc.)

Return values

void

◆ external_update_services()

external_update_services ( )

Allow plugins and subsystems to add external functions to other plugins or built-in services.

This function is executed just after all the plugins have been updated.

◆ extract_draft_file_urls_from_text()

extract_draft_file_urls_from_text	(	$text,
		$forcehttps = false,
		$contextid = null,
		$component = null,
		$filearea = null,
		$itemid = null,
		$filename = null )

Factory method for extracting draft file links from arbitrary text using regular expressions.

Only text is required; other file fields may be passed to filter.

Parameters

string	$text	Some html content.
bool	$forcehttps	force https urls.
int	$contextid	This parameter and the next three identify the file area to save to.
string	$component	The component name.
string	$filearea	The filearea.
int	$itemid	The item id for the filearea.
string	$filename	The specific filename of the file.

Return values

array

◆ fetch_context_capabilities()

fetch_context_capabilities ( )

Deprecated: since 2.2

◆ filter()

moodle_text_filter::filter	(		$text,
		array	$options = array() )

abstract

Override this function to actually implement the filtering.

Filter developers must make sure that filtering done after text cleaning does not introduce security vulnerabilities.

Parameters

string	$text	some HTML content to process.
array	$options	options passed to the filters

Return values

string the HTML content after the filtering has been applied.

Reimplemented in filter_activitynames, filter_algebra, filter_displayh5p, filter_emoticon, filter_glossary, filter_mathjaxloader, filter_mediaplugin, filter_multilang, filter_tidy, and filter_urltolink.

◆ filter_add_javascript()

filter_add_javascript ( $text )

Add missing openpopup javascript to HTML files.

Parameters

string $text

Return values

string

◆ filter_context_may_have_filter_settings()

filter_context_may_have_filter_settings ( $context )

Certain types of context (block and user) may not have local filter settings.

the function checks a context to see whether it may have local config.

Parameters

object $context a context.

Return values

boolean whether this context may have local filter settings.

◆ filter_delete_all_for_context()

filter_delete_all_for_context ( $contextid )

Delete all the data in the database relating to a context, used when contexts are deleted.

Parameters

integer $contextid The id of the context being deleted.

◆ filter_delete_all_for_filter()

filter_delete_all_for_filter ( $filter )

Delete all the data in the database relating to a filter, prior to deleting it.

Parameters

string $filter The filter name, for example 'tex'.

◆ filter_get_active_in_context()

filter_get_active_in_context ( $context )

Get the list of active filters, in the order that they should be used for a particular context, along with any local configuration variables.

Parameters

context $context a context

Return values

array an array where the keys are the filter names, for example 'tex' and the values are any local configuration for that filter, as an array of name => value pairs from the filter_config table. In a lot of cases, this will be an empty array. So, an example return value for this function might be array(tex' => array())

◆ filter_get_active_state()

filter_get_active_state	(	string	$filtername,
			$contextid = null )

Returns the active state for a filter in the given context.

Parameters

string	$filtername	The filter name, for example 'tex'.
integer	$contextid	The id of the context to get the data for.

Return values

int	value of active field for the given filter.

◆ filter_get_all_installed()

filter_get_all_installed ( )

Get the names of all the filters installed in this Moodle.

Return values

array path => filter name from the appropriate lang file. e.g. array('tex' => 'TeX Notation'); sorted in alphabetical order of name.

◆ filter_get_all_local_settings()

filter_get_all_local_settings ( $contextid )

This function is for use by backup.

Gets all the filter information specific to one context.

Parameters

int $contextid

Return values

array Array with two elements. The first element is an array of objects with fields filter and active. These come from the filter_active table. The second element is an array of objects with fields filter, name and value from the filter_config table.

◆ filter_get_available_in_context()

filter_get_available_in_context ( $context )

List all of the filters that are available in this context, and what the local and inherited states of that filter are.

Parameters

context $context a context that is not the system context.

Return values

array an array with filter names, for example 'tex' as keys. and and the values are objects with fields: ->filter filter name, same as the key. ->localstate TEXTFILTER_ON/OFF/INHERIT ->inheritedstate TEXTFILTER_ON/OFF - the state that will be used if localstate is set to TEXTFILTER_INHERIT.

◆ filter_get_global_states()

filter_get_global_states ( )

This function is for use by the filter administration page.

Return values

array 'filtername' => object with fields 'filter' (=filtername), 'active' and 'sortorder'

◆ filter_get_globally_enabled()

filter_get_globally_enabled ( )

Return a list of all the filters that may be in use somewhere.

Return values

array where the keys and values are both the filter name, like 'tex'.

◆ filter_get_globally_enabled_filters_with_config()

filter_get_globally_enabled_filters_with_config ( )

Get the globally enabled filters.

This returns the filters which could be used in any context. Essentially the filters which are not disabled for the entire site.

Return values

array Keys are filter names, and values the config.

◆ filter_get_local_config()

filter_get_local_config	(		$filter,
			$contextid )

Get local config variables for a filter in a context.

Normally (when your filter is running) you don't need to call this, becuase the config is fetched for you automatically. You only need this, for example, when you are getting the config so you can show the user an editing from.

Parameters

string	$filter	The filter name, for example 'tex'.
integer	$contextid	The ID of the context to get the local config for.

Return values

array of name => value pairs.

◆ filter_get_name()

filter_get_name ( $filter )

Look up the name of this filter.

Parameters

string $filter the filter name

Return values

string the human-readable name for this filter.

◆ filter_get_string_filters()

filter_get_string_filters ( )

Return the names of the filters that should also be applied to strings (when they are enabled).

Return values

array where the keys and values are both the filter name, like 'tex'.

◆ filter_has_global_settings()

filter_has_global_settings ( $filter )

Does this filter have a global settings page in the admin tree? (The settings page for a filter must be called, for example, filtersettingfiltertex.)

Parameters

string $filter The filter name, for example 'tex'.

Return values

boolean Whether there should be a 'Settings' link on the config page.

◆ filter_has_local_settings()

filter_has_local_settings ( $filter )

Does this filter have local (per-context) settings?

Parameters

string $filter The filter name, for example 'tex'.

Return values

boolean Whether there should be a 'Settings' link on the manage filters in context page.

◆ filter_is_enabled()

filter_is_enabled ( $filtername )

Parameters

string $filtername The filter name, for example 'tex'.

Return values

boolean is this filter allowed to be used on this site. That is, the admin has set the global 'active' setting to On, or Off, but available.

◆ filter_phrases()

filter_phrases	(	$text,
		$linkarray,
		$ignoretagsopen = null,
		$ignoretagsclose = null,
		$overridedefaultignore = false,
		$linkarrayalreadyprepared = false )

Process phrases intelligently found within a HTML text (such as adding links).

Parameters

string	$text	the text that we are filtering
filterobject[]	$linkarray	an array of filterobjects
array	$ignoretagsopen	an array of opening tags that we should ignore while filtering
array	$ignoretagsclose	an array of corresponding closing tags
bool	$overridedefaultignore	True to only use tags provided by arguments
bool	$linkarrayalreadyprepared	True to say that filter_prepare_phrases_for_filtering has already been called for $linkarray. Default false.

Return values

string

◆ filter_preload_activities()

filter_preload_activities ( course_modinfo $modinfo )

Preloads the list of active filters for all activities (modules) on the course using two database queries.

Parameters

course_modinfo $modinfo Course object from get_fast_modinfo

◆ filter_prepare_phrase_for_replacement()

filter_prepare_phrase_for_replacement ( filterobject $linkobject )

Fill in the remaining ->work... fields, that would be needed to replace the phrase.

Parameters

filterobject $linkobject the link object on which to set additional fields.

◆ filter_prepare_phrases_for_filtering()

filter_prepare_phrases_for_filtering ( array $linkarray )

Prepare a list of link for processing with filter_phrases().

Parameters

filterobject[] $linkarray the links that will be passed to filter_phrases().

Return values

filterobject[] the updated list of links with necessary pre-processing done.

◆ filter_remove_duplicates()

filter_remove_duplicates ( $linkarray )

Remove duplicate from a list of filterobject.

Parameters

filterobject[] $linkarray a list of filterobject.

Return values

filterobject[] the same list, but with dupicates removed.

◆ filter_save_ignore_tags()

filter_save_ignore_tags	(	&	$text,
			$filterignoretagsopen,
			$filterignoretagsclose,
		&	$ignoretags )

Extract open/lose tags and their contents to avoid being processed by filters.

Useful to extract pieces of code like ... tags. It returns the text converted with some <#xTEXTFILTER_EXCL_SEPARATORx#> codes replacing the extracted text. Such extracted texts are returned in the ignoretags array (as values), with codes as keys.

Parameters

string	$text	the text that we are filtering (in/out)
array	$filterignoretagsopen	an array of open tags to start searching
array	$filterignoretagsclose	an array of close tags to end searching
array	$ignoretags	an array of saved strings useful to rebuild the original text (in/out)

◆ filter_save_tags()

filter_save_tags	(	&	$text,
		&	$tags )

Extract tags (any text enclosed by < and > to avoid being processed by filters.

It returns the text converted with some <xTEXTFILTER_EXCL_SEPARATORx%> codes replacing the extracted text. Such extracted texts are returned in the tags array (as values), with codes as keys.

Parameters

string	$text	the text that we are filtering (in/out)
array	$tags	an array of saved strings useful to rebuild the original text (in/out)

◆ filter_set_applies_to_strings()

filter_set_applies_to_strings	(		$filter,
			$applytostrings )

Sets whether a particular active filter should be applied to all strings by format_string, or just used by format_text.

Parameters

string	$filter	The filter name, for example 'tex'.
boolean	$applytostrings	if true, this filter will apply to format_string and format_text, when it is enabled.

◆ filter_set_global_state()

filter_set_global_state	(	$filtername,
		$state,
		$move = 0 )

Set the global activated state for a text filter.

Parameters

string	$filtername	The filter name, for example 'tex'.
int	$state	One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.
int	$move	-1 means up, 0 means the same, 1 means down

◆ filter_set_local_config()

filter_set_local_config	(	$filter,
		$contextid,
		$name,
		$value )

Set a particular local config variable for a filter in a context.

Parameters

string	$filter	The filter name, for example 'tex'.
integer	$contextid	The id of the context to get the local config for.
string	$name	the setting name.
string	$value	the corresponding value.

◆ filter_set_local_state()

filter_set_local_state	(	$filter,
		$contextid,
		$state )

Set the local activated state for a text filter.

Parameters

string	$filter	The filter name, for example 'tex'.
integer	$contextid	The id of the context to get the local config for.
integer	$state	One of the values TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_INHERIT.

Return values

void

◆ filter_stage_post_clean()

moodle_text_filter::filter_stage_post_clean	(	string	$text,
		array	$options )

Filter HTML text at the very end after text is sanitised.

NOTE: this is called even if $options['noclean'] is true and text is not cleaned.

Parameters

string	$text
array	$options

Return values

string

◆ filter_stage_pre_clean()

moodle_text_filter::filter_stage_pre_clean	(	string	$text,
		array	$options )

Filter HTML text before sanitising text.

NOTE: this is called even if $options['noclean'] is true and text is not cleaned.

Parameters

string	$text
array	$options

Return values

string

◆ filter_stage_pre_format()

moodle_text_filter::filter_stage_pre_format	(	string	$text,
		array	$options )

Filter text before changing format to HTML.

Parameters

string	$text
array	$options

Return values

string

◆ filter_stage_string()

moodle_text_filter::filter_stage_string	(	string	$text,
		array	$options )

Filter simple text coming from format_string().

Note that unless $CFG->formatstringstriptags is disabled HTML tags are not expected in returned value.

Parameters

string	$text
array	$options

Return values

string

◆ filter_string() [1/3]

filter_manager::filter_string	(		$string,
			$context )

Filter a piece of string.

Parameters

string	$string	The text to filter
context	$context	the context.

Return values

string resulting string

Reimplemented in performance_measuring_filter_manager.

◆ filter_string() [2/3]

null_filter_manager::filter_string	(		$string,
			$context )

As for the equivalent filter_manager method.

Parameters

string	$string	The text to filter
context	$context	not used.

Return values

string resulting string

◆ filter_string() [3/3]

performance_measuring_filter_manager::filter_string	(		$string,
			$context )

Filter a piece of string.

Parameters

string	$string	The text to filter
context	$context	the context.

Return values

string resulting string

Reimplemented from filter_manager.

◆ filter_text() [1/4]

filter_manager::filter_text	(		$text,
			$context,
		array	$options = array(),
		array	$skipfilters = null )

Filter some text.

Parameters

string	$text	The text to filter
context	$context	the context.
array	$options	options passed to the filters
array	$skipfilters	of filter names. Any filters that should not be applied to this text.

Return values

string resulting text

Reimplemented in performance_measuring_filter_manager.

◆ filter_text() [2/4]

filter_text ( )

Deprecated: use the text formatting in a standard way instead (https://moodledev.io/docs/apis/subsystems/output#output-functions) this was abused mostly for embedding of attachments

◆ filter_text() [3/4]

null_filter_manager::filter_text	(		$text,
			$context,
		array	$options = array(),
		array	$skipfilters = null )

As for the equivalent filter_manager method.

Parameters

string	$text	The text to filter
context	$context	not used.
array	$options	not used
array	$skipfilters	not used

Return values

string resulting text.

◆ filter_text() [4/4]

performance_measuring_filter_manager::filter_text	(		$text,
			$context,
		array	$options = array(),
		array	$skipfilters = null )

Filter some text.

Parameters

string	$text	The text to filter
context	$context	the context.
array	$options	options passed to the filters
array	$skipfilters	of filter names. Any filters that should not be applied to this text.

Return values

string resulting text

Reimplemented from filter_manager.

◆ filter_unset_local_config()

filter_unset_local_config	(	$filter,
		$contextid,
		$name )

Remove a particular local config variable for a filter in a context.

Parameters

string	$filter	The filter name, for example 'tex'.
integer	$contextid	The id of the context to get the local config for.
string	$name	the setting name.

◆ find_day_in_month()

find_day_in_month	(	$startday,
		$weekday,
		$month,
		$year )

Calculates when the day appears in specific month.

Parameters

int	$startday	starting day of the month
int	$weekday	The day when week starts (normally taken from user preferences)
int	$month	The month whose day is sought
int	$year	The year of the month whose day is sought

Return values

int

◆ fix_align_rtl()

fix_align_rtl ( $align )

Returns swapped left<=> right if in RTL environment.

Part of RTL Moodles support.

Parameters

string $align align to check

Return values

string

◆ fix_course_sortorder()

object fix_course_sortorder ( )

Fixes course category and course sortorder, also verifies category and course parents and paths.

(circular references are not fixed)

@global object @uses MAX_COURSE_CATEGORIES @uses SITEID @uses CONTEXT_COURSE

Return values

void

◆ fix_current_language()

fix_current_language ( string $lang )

Fix the current language to the given language code.

Parameters

string $lang The language code to use.

Return values

void

◆ fix_utf8()

fix_utf8 ( $value )

Makes sure the data is using valid utf8, invalid characters are discarded.

Note: this function is not intended for full objects with methods and private properties.

Parameters

mixed $value

Return values

mixed with proper utf-8 encoding

◆ flatten_category_tree()

flatten_category_tree	(	&	$categories,
			$id,
			$depth = 0,
			$nochildrenof = -1 )

Private method, only for the use of add_indented_names().

Recursively adds an indentedname field to each category, starting with the category with id $id, and dealing with that category and all its children, and return a new array, with those categories in the right order.

Parameters

array	$categories	an array of categories which has had childids fields added by flatten_category_tree(). Passed by reference for performance only. It is not modfied.
int	$id	the category to start the indenting process from.
int	$depth	the indent depth. Used in recursive calls.
int	$nochildrenof

Return values

array a new array of categories, in the right order for the tree.

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ force_current_language()

force_current_language ( $language )

Force the current language to get strings and dates localised in the given language.

After calling this function, all strings will be provided in the given language until this function is called again, or equivalent code is run.

Parameters

string $language

Return values

string previous $SESSION->forcelang value

◆ format_admin_setting()

format_admin_setting	(	$setting,
		$title = '',
		$form = '',
		$description = '',
		$label = true,
		$warning = '',
		$defaultinfo = NULL,
		$query = '' )

Format admin settings.

Parameters

object	$setting
string	$title	label element
string	$form	form fragment, html code - not highlighted automatically
string	$description
mixed	$label	link label to id, true by default or string being the label to connect it to
string	$warning	warning text
sting	$defaultinfo	defaults info, null means nothing, '' is converted to "Empty" string, defaults to null
string	$query	search query to be highlighted

Return values

string XHTML

◆ format_backtrace()

format_backtrace	(		$callers,
			$plaintext = false )

Formats a backtrace ready for output.

This function does not include function arguments because they could contain sensitive information not suitable to be exposed in a response.

Parameters

array	$callers	backtrace array, as returned by debug_backtrace().
boolean	$plaintext	if false, generates HTML, if true generates plain text.

Return values

string formatted backtrace, ready for output.

◆ format_float()

format_float	(	$float,
		$decimalpoints = 1,
		$localized = true,
		$stripzeros = false )

Given a float, prints it nicely.

Localized floats must not be used in calculations!

The stripzeros feature is intended for making numbers look nicer in small areas where it is not necessary to indicate the degree of accuracy by showing ending zeros. If you turn it on with $decimalpoints set to 3, for example, then it will display '5.4' instead of '5.400' or '5' instead of '5.000'.

Parameters

float	$float	The float to print
int	$decimalpoints	The number of decimal places to print. -1 is a special value for auto detect (full precision).
bool	$localized	use localized decimal separator
bool	$stripzeros	If true, removes final zeros after decimal point. It will be ignored and the trailing zeros after the decimal point are always striped if $decimalpoints is -1.

Return values

string locale float

◆ format_module_intro()

format_module_intro	(	$module,
		$activity,
		$cmid,
		$filter = true )

Formats activity intro text.

Parameters

string	$module	name of module
object	$activity	instance of activity
int	$cmid	course module id
bool	$filter	filter resulting html text

Return values

string

◆ format_string()

format_string	(	$string,
		$striplinks = true,
		$options = null )

Given a simple string, this function returns the string processed by enabled string filters if $CFG->filterall is enabled.

This function should be used to print short strings (non html) that need filter processing e.g. activity titles, post subjects, glossary concepts.

@staticvar bool $strcache

Parameters

string	$string	The string to be filtered. Should be plain text, expect possibly for multilang tags.
boolean	$striplinks	To strip any link in the result text. Moodle 1.8 default changed from false to true! MDL-8713
array	$options	options array/object or courseid

Return values

string

◆ format_text()

format_text	(	$text,
		$format = FORMAT_MOODLE,
		$options = null,
		$courseiddonotuse = null )

Given text in a variety of format codings, this function returns the text as safe HTML.

This function should mainly be used for long strings like posts, answers, glossary items etc. For short strings format_string().

Options:
     trusted     :   If true the string won't be cleaned. Default false required noclean=true.
     noclean     :   If true the string won't be cleaned, unless $CFG->forceclean is set. Default false required trusted=true.
     nocache     :   If true the strign will not be cached and will be formatted every call. Default false.
     filter      :   If true the string will be run through applicable filters as well. Default true.
     para        :   If true then the returned string will be wrapped in div tags. Default true.
     newlines    :   If true then lines newline breaks will be converted to HTML newline breaks. Default true.
     context     :   The context that will be used for filtering.
     overflowdiv :   If set to true the formatted text will be encased in a div
                     with the class no-overflow before being returned. Default false.
     allowid     :   If true then id attributes will not be removed, even when
                     using htmlpurifier. Default false.
     blanktarget :   If true all  tags will have target="_blank" added unless target is explicitly specified.

@staticvar array $croncache

Parameters

string	$text	The text to be formatted. This is raw text originally from user input.
int	$format	Identifier of the text format to be used [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN]
stdClass \| array	$options	text formatting options
int	$courseiddonotuse	deprecated course id, use context option instead

Return values

string

◆ format_text_email()

format_text_email	(		$text,
			$format )

Given text in a variety of format codings, this function returns the text as plain text suitable for plain email.

Parameters

string	$text	The text to be formatted. This is raw text originally from user input.
int	$format	Identifier of the text format to be used [FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_WIKI, FORMAT_MARKDOWN]

Return values

string

◆ format_text_menu()

format_text_menu ( )

Just returns an array of text formats suitable for a popup menu.

Return values

array

◆ format_time()

format_time	(		$totalsecs,
			$str = null )

Format a date/time (seconds) as weeks, days, hours etc as needed.

Given an amount of time in seconds, returns string formatted nicely as years, days, hours etc as needed

@uses MINSECS @uses HOURSECS @uses DAYSECS @uses YEARSECS

Parameters

int	$totalsecs	Time in seconds
stdClass	$str	Should be a time object

Return values

string A nicely formatted date/time string

◆ format_weeks_get_section_dates()

format_weeks_get_section_dates ( )

Deprecated: since 2.4

◆ formerr()

formerr ( )

Deprecated

◆ fullclone()

fullclone ( $thing )

This function will make a complete copy of anything it's given, regardless of whether it's an object or not.

Parameters

mixed $thing Something you want cloned

Return values

mixed What ever it is you passed it

◆ fullname()

fullname	(		$user,
			$override = false )

Returns a persons full name.

Given an object containing all of the users name values, this function returns a string with the full name of the person. The result may depend on system settings or language. 'override' will force the alternativefullnameformat to be used. In English, fullname as well as alternativefullnameformat is set to 'firstname lastname' by default. But you could have fullname set to 'firstname lastname' and alternativefullnameformat set to 'firstname middlename alternatename lastname'.

Parameters

stdClass	$user	A $USER object to get full name of.
bool	$override	If true then the alternativefullnameformat format rather than fullnamedisplay format will be used.

Return values

string

◆ gc_cache_flags()

gc_cache_flags ( )

Garbage-collect volatile flags.

Return values

bool	Always returns true

◆ generate_email_messageid()

generate_email_messageid ( $localpart = null )

Generate a unique email Message-ID using the moodle domain and install path.

Parameters

string $localpart An optional unique message id prefix.

Return values

string The formatted ID ready for appending to the email headers.

◆ generate_email_processing_address()

generate_email_processing_address	(		$modid,
			$modargs )

Generate an email processing address.

Parameters

int	$modid
string	$modargs

Return values

string Returns email processing address

◆ generate_email_signoff()

generate_email_signoff ( )

Generate a signoff for emails based on support settings.

Return values

string

◆ generate_email_supportuser()

generate_email_supportuser ( )

Deprecated: since Moodle 2.6

◆ generate_image_thumbnail()

generate_image_thumbnail	(	$filepath,
		$width,
		$height )

Generates a thumbnail for the given image.

If the GD library has at least version 2 and PNG support is available, the returned data is the content of a transparent PNG file containing the thumbnail. Otherwise, the function returns contents of a JPEG file with black background containing the thumbnail.

Parameters

string	$filepath	the full path to the original image file
int	$width	the width of the requested thumbnail
int	$height	the height of the requested thumbnail

Return values

string|bool false if a problem occurs, the thumbnail image data otherwise

◆ generate_image_thumbnail_from_image()

generate_image_thumbnail_from_image	(	$original,
		$imageinfo,
		$width,
		$height )

Generates a thumbnail for the given image string.

If the GD library has at least version 2 and PNG support is available, the returned data is the content of a transparent PNG file containing the thumbnail. Otherwise, the function returns contents of a JPEG file with black background containing the thumbnail.

Parameters

resource	$original	The image to work on.
array	$imageinfo	Contains [0] => originalwidth, [1] => originalheight.
int	$width	The width of the requested thumbnail.
int	$height	The height of the requested thumbnail.

Return values

string|bool False if a problem occurs, the thumbnail image data otherwise.

◆ generate_image_thumbnail_from_string()

generate_image_thumbnail_from_string	(	$filedata,
		$width,
		$height )

Generates a thumbnail for the given image string.

If the GD library has at least version 2 and PNG support is available, the returned data is the content of a transparent PNG file containing the thumbnail. Otherwise, the function returns contents of a JPEG file with black background containing the thumbnail.

Parameters

string	$filedata	The image content as a string
int	$width	the width of the requested thumbnail
int	$height	the height of the requested thumbnail

Return values

string|bool false if a problem occurs, the thumbnail image data otherwise

◆ generate_page_type_patterns()

generate_page_type_patterns	(	$pagetype,
		$parentcontext = null,
		$currentcontext = null )

Given a specific page type, parent context and currect context, return all the page type patterns that might be used by this block.

Parameters

string	$pagetype	for example 'course-view-weeks' or 'mod-quiz-view'.
stdClass	$parentcontext	Block's parent context
stdClass	$currentcontext	Current context of block

Return values

array an array of all the page type patterns that might match this page type.

◆ generate_password()

generate_password ( $maxlen = 10 )

Returns a randomly generated password of length $maxlen.

inspired by

and

Parameters

int $maxlen The maximum size of the password being generated.

Return values

string

◆ generate_uuid()

generate_uuid ( )

Deprecated: since Moodle 3.8 MDL-61038 - please do not use this function any more.

See also: core\uuid\generate()

◆ get_accesshide()

get_accesshide	(	$text,
		$elem = 'span',
		$class = '',
		$attrs = '' )

Return a HTML element with the class "accesshide", for accessibility.

Please use cautiously - where possible, text should be visible!

Parameters

string	$text	Plain text.
string	$elem	Lowercase element name, default "span".
string	$class	Additional classes for the element.
string	$attrs	Additional attributes string in the form, "name='value' name2='value2'"

Return values

string HTML string.

◆ get_admin()

if(!defined('LASTACCESS_UPDATE_SECS')) get_admin ( )

static

Number of seconds to wait before updating lastaccess information in DB.

We allow overwrites from config.php, useful to ensure coherence in performance tests results.

Note: For web service requests in the external_tokens field, we use a different constant webservice\TOKEN_LASTACCESS_UPDATE_SECS. Returns $user object of the main admin user

stdClass $mainadmin

Return values

stdClass $USER record from DB, false if not found

◆ get_admins()

get_admins ( )

Returns list of all admins, using 1 DB query.

Return values

array

◆ get_all_component_hash()

static get_all_component_hash ( ?array $components = null )

static

Returns hash of all core + plugin /db/ directories.

This is relatively slow and not fully cached, use with care!

Parameters

array | null $components optional component directory => hash array to use. Only used in PHPUnit.

Return values

string sha1 hash.

◆ get_all_directory_hashes()

static get_all_directory_hashes ( ?array $directories = null )

static

Get the hashes of all core + plugin /db/ directories.

Parameters

array | null $directories optional component directory array to hash. Only used in PHPUnit.

Return values

array of directory => hash.

◆ get_all_instances_in_course()

get_all_instances_in_course	(	$modulename,
		$course,
		$userid = NULL,
		$includeinvisible = false )

Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined.

Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined in the course. Returns an empty array on any errors.

The returned objects includle the columns cw.section, cm.visible, cm.groupmode, and cm.groupingid, and are indexed by cm.id.

Simply calls all_instances_in_courses() with a single provided course

Parameters

string	$modulename	The name of the module to get instances for
object	$course	The course obect.

Return values

array of module instance objects, including some extra fields from the course_modules and course_sections tables, or an empty array if an error occurred.

Parameters

int	$userid
int	$includeinvisible

◆ get_all_instances_in_courses()

object get_all_instances_in_courses	(	$modulename,
		$courses,
		$userid = NULL,
		$includeinvisible = false )

Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined.

Returns an array of all the active instances of a particular module in given courses, sorted in the order they are defined in the course. Returns an empty array on any errors.

The returned objects includle the columns cw.section, cm.visible, cm.groupmode, cm.groupingid and cm.lang and are indexed by cm.id.

@global object

Parameters

string	$modulename	The name of the module to get instances for
array	$courses	an array of course objects.
int	$userid
int	$includeinvisible

Return values

array of module instance objects, including some extra fields from the course_modules and course_sections tables, or an empty array if an error occurred.

◆ get_all_mods()

get_all_mods ( )

Deprecated: since 2.4

◆ get_all_sections()

get_all_sections ( )

Deprecated: since 2.4

◆ get_all_subcategories()

get_all_subcategories ( )

Deprecated: since 2.5. Please use core_course_category\get() and core_course_category\get_children()

◆ get_all_user_name_fields()

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

A centralised location for the all name fields.

Returns an array / sql string snippet.

Parameters

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

Return values

array|string All name fields.

Deprecated: since Moodle 3.11 MDL-45242

See also: core_user\fields

◆ get_all_versions()

static get_all_versions ( )

static

Returns hash of all versions including core and all plugins.

This is relatively slow and not fully cached, use with care!

Return values

array as (string)plugintype_pluginname => (int)version

◆ get_all_versions_hash()

static get_all_versions_hash ( )

static

Returns hash of all versions including core and all plugins.

This is relatively slow and not fully cached, use with care!

Return values

string sha1 hash

◆ get_array_of_activities()

get_array_of_activities	(	int	$courseid,
		bool	$usecache = false )

For a given course, returns an array of course activity objects Each item in the array contains he following properties:

Parameters

int	$courseid	course id
bool	$usecache	get activities from cache if modinfo exists when $usecache is true

Return values

array list of activities

Deprecated: since Moodle 4.0. Please use course_modinfo::get_array_of_activities() instead.

◆ get_auth_plugin()

get_auth_plugin ( $auth )

Returns an authentication plugin instance.

Parameters

string $auth name of authentication plugin

Return values

auth_plugin_base An instance of the required authentication plugin.

◆ get_backpack_settings()

get_backpack_settings	(		$userid,
			$refresh = false )

Returns external backpack settings and badges from this backpack.

This function first checks if badges for the user are cached and tries to retrieve them from the cache. Otherwise, badges are obtained through curl request to the backpack.

Parameters

int	$userid	Backpack user ID.
boolean	$refresh	Refresh badges collection in cache.

Return values

null|object Returns null is there is no backpack or object with backpack settings.

◆ get_backup_temp_directory()

get_backup_temp_directory ( $directory )

Get the full path of a directory under $CFG->backuptempdir.

Parameters

string $directory the relative path of the directory under $CFG->backuptempdir

Return values

string|false Returns full path to directory given a valid string; otherwise, false.

◆ get_browser_version_classes()

get_browser_version_classes ( )

Deprecated: since 2.6

◆ get_cache_flag()

get_cache_flag	(	$type,
		$name,
		$changedsince = null )

Get volatile flags.

Parameters

string	$type
string	$name
int	$changedsince	default null

Return values

string|false The cache flag value or false

◆ get_cache_flags()

get_cache_flags	(		$type,
			$changedsince = null )

Get volatile flags.

Parameters

string	$type
int	$changedsince	default null

Return values

array records array

◆ get_callable_name()

get_callable_name ( $callable )

Get human readable name describing the given callable.

This performs syntax check only to see if the given param looks like a valid function, method or closure. It does not check if the callable actually exists.

Parameters

callable | string | array $callable

Return values

string|bool Human readable name of callable, or false if not a valid callable.

◆ get_categories()

get_categories ( )

Deprecated: since 2.5

◆ get_categories_for_contexts()

get_categories_for_contexts	(		$contexts,
			$sortorder = 'parent,
		sortorder	,
		name ASC'	,
			$top = false )

Get all the category objects, including a count of the number of questions in that category, for all the categories in the lists $contexts.

Parameters

mixed	$contexts	either a single contextid, or a comma-separated list of context ids.
string	$sortorder	used as the ORDER BY clause in the select statement.
bool	$top	Whether to return the top categories or not.

Return values

array of category objects.

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ get_category_courses_array()

get_category_courses_array ( )

Deprecated: since 2.5

◆ get_category_courses_array_recursively()

get_category_courses_array_recursively ( )

Deprecated: since 2.5

◆ get_child_categories()

get_child_categories ( )

Deprecated: since 2.5. Please use core_course_category\get($parentid)->get_children().

◆ get_child_contexts()

get_child_contexts ( )

Deprecated: since 2.2

◆ get_clam_error_code()

get_clam_error_code ( )

Deprecated: since Moodle 3.0 - this is a part of clamav plugin now.

◆ get_complete_user_data()

get_complete_user_data	(	$field,
		$value,
		$mnethostid = null,
		$throwexception = false )

Get a complete user record, which includes all the info in the user record.

Intended for setting as $USER session variable

Parameters

string	$field	The user field to be checked for a given value.
string	$value	The value to match for $field.
int	$mnethostid
bool	$throwexception	If true, it will throw an exception when there's no record found or when there are multiple records found. Otherwise, it will just return false.

Return values

mixed False, or A $USER object.

◆ get_component_classes_in_namespace()

static get_component_classes_in_namespace	(		$component = null,
			$namespace = '' )

static

Returns all classes in a component matching the provided namespace.

It checks that the class exists.

e.g. get_component_classes_in_namespace('mod_forum', 'event')

Parameters

string \| null	$component	A valid moodle component (frankenstyle) or null if searching all components
string	$namespace	Namespace from the component name or empty string if all $component classes.

Return values

array The full class name as key and the class path as value, empty array if $component is null and $namespace is empty.

◆ get_component_directory()

get_component_directory ( $component )

static

Return exact absolute path to a plugin directory.

Parameters

string $component name such as 'moodle', 'mod_forum'

Return values

string full path to component directory; NULL if not found

Deprecated: since 2.6, use core_component\normalize_component()

Parameters

string $component name such as 'moodle', 'mod_forum'

Return values

string full path to component directory; NULL if not found

◆ get_component_list()

static get_component_list ( )

static

Returns a list of frankenstyle component names and their paths, for all components (plugins and subsystems).

E.g. [ 'mod' => [ 'mod_forum' => FORUM_PLUGIN_PATH, ... ], ... 'core' => [ 'core_comment' => COMMENT_SUBSYSTEM_PATH, ... ] ]

Return values

array an associative array of components and their corresponding paths.

◆ get_component_names()

static get_component_names ( )

static

Returns a list of frankenstyle component names.

E.g. [ 'core_course', 'core_message', 'mod_assign', ... ]

Return values

array the list of frankenstyle component names.

◆ get_component_version()

get_component_version	(		$component,
			$source = 'installed' )

Returns the version of installed component.

Parameters

string	$component	component name
string	$source	either 'disk' or 'installed' - where to get the version information from

Return values

string|bool version number or false if the component is not found

◆ get_config()

get_config	(		$plugin,
			$name = null )

Get configuration values from the global config table or the config_plugins table.

If called with one parameter, it will load all the config variables for one plugin, and return them as an object.

If called with 2 parameters it will return a string single value or false if the value is not found.

NOTE: this function is called from lib/db/upgrade.php

Parameters

string	$plugin	full component name
string	$name	default null

Return values

mixed hash-like object or single value, return false no config found

Exceptions

◆ get_context_instance()

get_context_instance	(	$contextlevel,
		$instance = 0,
		$strictness = IGNORE_MISSING )

Get the context instance as an object.

This function will create the context instance if it does not exist yet.

Deprecated: since 2.2, use context_course\instance() or other relevant class instead

Todo: This will be deleted in Moodle 2.8, refer MDL-34472

Parameters

integer	$contextlevel	The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
integer	$instance	The instance id. For $level = CONTEXT_COURSE, this would be $course->id, for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

context The context object.

◆ get_context_instance_by_id()

get_context_instance_by_id ( )

Deprecated: since Moodle 2.2 MDL-35009 - please do not use this function any more.

◆ get_context_url()

get_context_url ( )

Deprecated: since 2.2

◆ get_contextlevel_name()

get_contextlevel_name ( )

Deprecated: since 2.2

◆ get_core_api_names()

static get_core_api_names ( )

static

Returns the list of available API names.

Return values

string[] the list of available API names.

◆ get_core_apis()

static get_core_apis ( )

static

List all core APIs and their attributes.

This is a list of all the existing / allowed APIs in moodle, each one with the following attributes:

component: the component, usually a subsystem or core, the API belongs to.
allowedlevel2: if the API is allowed as level2 namespace or no.
allowedspread: if the API can spread out from its component or no.

Return values

stdClass[] array of APIs (as keys) with their attributes as object instances.

◆ get_core_subsystems() [1/2]

get_core_subsystems ( $fullpaths = false )

List all core subsystems and their location.

This is a list of components that are part of the core and their language strings are defined in /lang/en/<<subsystem>>.php. If a given plugin is not listed here and it does not have proper plugintype prefix, then it is considered as course activity module.

The location is optionally dirroot relative path. NULL means there is no special directory for this subsystem. If the location is set, the subsystem's renderer.php is expected to be there.

Deprecated: since 2.6, use core_component\get_core_subsystems()

Parameters

bool $fullpaths false means relative paths from dirroot, use true for performance reasons

Return values

array of (string)name => (string|null)location

◆ get_core_subsystems() [2/2]

static get_core_subsystems ( )

static

List all core subsystems and their location.

This is a list of components that are part of the core and their language strings are defined in /lang/en/<<subsystem>>.php. If a given plugin is not listed here and it does not have proper plugintype prefix, then it is considered as course activity module.

The location is absolute file path to dir. NULL means there is no special directory for this subsystem. If the location is set, the subsystem's renderer.php is expected to be there.

Return values

array of (string)name => (string|null)full dir location

◆ get_course()

get_course	(		$courseid,
			$clone = true )

Gets a course object from database.

If the course id corresponds to an already-loaded $COURSE or $SITE object, then the loaded object will be used, saving a database query.

If it reuses an existing object, by default the object will be cloned. This means you can modify the object safely without affecting other code.

Parameters

int	$courseid	Course id
bool	$clone	If true (default), makes a clone of the record

Return values

stdClass A course object

Exceptions

dml_exception If not found in database

◆ get_course_and_cm_from_cmid()

get_course_and_cm_from_cmid	(	$cmorid,
		$modulename = '',
		$courseorid = 0,
		$userid = 0 )

Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given a cmid.

If module name is also provided, it will ensure the cm is of that type.

Usage: list($course, $cm) = get_course_and_cm_from_cmid($cmid, 'forum');

Using this method has a performance advantage because it works by loading modinfo for the course - which will then be cached and it is needed later in most requests. It also guarantees that the $cm object is a cm_info and not a stdclass.

The $course object can be supplied if already known and will speed up this function - although it is more efficient to use this function to get the course if you are starting from a cmid.

To avoid security problems and obscure bugs, you should always specify $modulename if the cmid value came from user input.

By default this obtains information (for example, whether user can access the activity) for current user, but you can specify a userid if required.

Parameters

stdClass \| int	$cmorid	Id of course-module, or database object
string	$modulename	Optional modulename (improves security)
stdClass \| int	$courseorid	Optional course object if already loaded
int	$userid	Optional userid (default = current)

Return values

array Array with 2 elements $course and $cm

Exceptions

moodle_exception If the item doesn't exist or is of wrong module name

◆ get_course_and_cm_from_instance()

get_course_and_cm_from_instance	(	$instanceorid,
		$modulename,
		$courseorid = 0,
		$userid = 0 )

Efficiently retrieves the $course (stdclass) and $cm (cm_info) objects, given an instance id or record and module name.

Usage: list($course, $cm) = get_course_and_cm_from_instance($forum, 'forum');

Using this method has a performance advantage because it works by loading modinfo for the course - which will then be cached and it is needed later in most requests. It also guarantees that the $cm object is a cm_info and not a stdclass.

The $course object can be supplied if already known and will speed up this function - although it is more efficient to use this function to get the course if you are starting from an instance id.

By default this obtains information (for example, whether user can access the activity) for current user, but you can specify a userid if required.

Parameters

stdclass \| int	$instanceorid	Id of module instance, or database object
string	$modulename	Modulename (required)
stdClass \| int	$courseorid	Optional course object if already loaded
int	$userid	Optional userid (default = current)

Return values

array Array with 2 elements $course and $cm

Exceptions

moodle_exception If the item doesn't exist or is of wrong module name

◆ get_course_category()

get_course_category ( )

Deprecated: since 2.5. Please use core_course_category\get($catid, IGNORE_MISSING) or core_course_category\get($catid, MUST_EXIST).

◆ get_course_category_tree()

get_course_category_tree ( )

Deprecated: since 2.5

◆ get_course_context()

get_course_context ( )

Deprecated: since 2.2

◆ get_course_display_name_for_list()

get_course_display_name_for_list ( $course )

Gets the name of a course to be displayed when showing a list of courses.

By default this is just $course->fullname but user can configure it. The result of this function should be passed through print_string.

Parameters

stdClass | core_course_list_element $course Moodle course object

Return values

string Display name of course (either fullname or short + fullname)

◆ get_course_mods()

object get_course_mods ( $courseid )

MODULE FUNCTIONS /////////////////////////////////////////////////.

Just gets a raw list of all modules in a course

Parameters

int $courseid The id of the course as found in the 'course' table.

Return values

array

◆ get_course_participants()

get_course_participants ( )

Deprecated: use get_enrolled_users($context) instead.

◆ get_course_section()

get_course_section ( )

Deprecated: since 2.4

◆ get_courseid_from_context()

get_courseid_from_context ( )

Deprecated: since 2.2

◆ get_coursemodule_from_id()

object get_coursemodule_from_id	(	$modulename,
		$cmid,
		$courseid = 0,
		$sectionnum = false,
		$strictness = IGNORE_MISSING )

Given an id of a course module, finds the coursemodule description.

Please note that this function performs 1-2 DB queries. When possible use cached course modinfo. For example get_fast_modinfo($courseorid)->get_cm($cmid) See also cm_info::get_course_module_record()

Parameters

string	$modulename	name of module type, eg. resource, assignment,... (optional, slower and less safe if not specified)
int	$cmid	course module id (id in course_modules table)
int	$courseid	optional course id for extra validation
bool	$sectionnum	include relative section number (0,1,2 ...)
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended); MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

◆ get_coursemodule_from_instance()

object get_coursemodule_from_instance	(	$modulename,
		$instance,
		$courseid = 0,
		$sectionnum = false,
		$strictness = IGNORE_MISSING )

Given an instance number of a module, finds the coursemodule description.

Please note that this function performs DB query. When possible use cached course modinfo. For example get_fast_modinfo($courseorid)->instances[$modulename][$instance] See also cm_info::get_course_module_record()

Parameters

string	$modulename	name of module type, eg. resource, assignment,...
int	$instance	module instance number (id in resource, assignment etc. table)
int	$courseid	optional course id for extra validation
bool	$sectionnum	include relative section number (0,1,2 ...)
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; IGNORE_MULTIPLE means return first, ignore multiple records found(not recommended); MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

◆ get_coursemodules_in_course()

get_coursemodules_in_course	(	$modulename,
		$courseid,
		$extrafields = '' )

Returns all course modules of given activity in course.

Parameters

string	$modulename	The module name (forum, quiz, etc.)
int	$courseid	The course id to get modules for
string	$extrafields	extra fields starting with m.

Return values

array Array of results

◆ get_courses() [1/2]

core_course_category::get_courses ( $options = array() )

Retrieves the list of courses accessible by user.

was called with option 'summary'.

Not all information is cached, try to avoid calling this method twice in the same request.

The following fields are always retrieved:

id, visible, fullname, shortname, idnumber, category, sortorder

If you plan to use properties/methods core_course_list_element\$summary and/or core_course_list_element\get_course_contacts() you can preload this information using appropriate 'options'. Otherwise they will be retrieved from DB on demand and it may end with bigger DB load.

Note that method core_course_list_element\has_summary() will not perform additional DB queries even if $options['summary'] is not specified

List of found course ids is cached for 10 minutes. Cache may be purged prior to this when somebody edits courses or categories, however it is very difficult to keep track of all possible changes that may affect list of courses.

Parameters

array

$options

options for retrieving children

recursive - return courses from subcategories as well. Use with care, this may be a huge list!
summary - preloads fields 'summary' and 'summaryformat'
coursecontacts - preloads course contacts
sort - list of fields to sort. Example array('idnumber' => 1, 'shortname' => 1, 'id' => -1) will sort by idnumber asc, shortname asc and id desc. Default: array('sortorder' => 1) Only cached fields may be used for sorting!
offset
limit - maximum number of children to return, 0 or null for no limit
idonly - returns the array or course ids instead of array of objects used only in get_courses_count()

Return values

core_course_list_element[]

Otherwise will be retrieved from DB on first request

◆ get_courses() [2/2]

object get_courses	(	$categoryid = "all",
		$sort = "c.sortorder ASC",
		$fields = "c.*" )

Returns list of courses, for whole site, or category.

Returns list of courses, for whole site, or category 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

Consider using core_course_category\get_courses() or core_course_category\search_courses() instead since they use caching.

@global object @global object @uses CONTEXT_COURSE

Parameters

string \| int	$categoryid	Either a category id or 'all' for everything
string	$sort	A field and direction to sort by
string	$fields	The additional fields to return (note that "id, category, visible" are always present)

Return values

array Array of courses

◆ get_courses_page()

get_courses_page ( )

Deprecated: since Moodle 3.7

◆ get_courses_search()

object get_courses_search	(		$searchterms,
			$sort,
			$page,
			$recordsperpage,
		&	$totalcount,
			$requiredcapabilities = array(),
			$searchcond = [],
			$params = [] )

A list of courses that match a search.

@global object

Parameters

array	$searchterms	An array of search criteria
string	$sort	A field and direction to sort by
int	$page	The page number to get
int	$recordsperpage	The number of records per page
int	$totalcount	Passed in by reference.
array	$requiredcapabilities	Extra list of capabilities used to filter courses
array	$searchcond	additional search conditions, for example ['c.enablecompletion = :p1']
array	$params	named parameters for additional search conditions, for example ['p1' => 1]

Return values

stdClass[] $COURSE records

◆ get_courses_wmanagers()

get_courses_wmanagers ( )

Deprecated: since 2.5

◆ get_current_group()

get_current_group ( )

Deprecated: Since year 2006 - please do not use this function any more.

◆ get_db_directories()

get_db_directories ( )

Returns list of all directories where we expect install.xml files.

Return values

array Array of paths

◆ get_db_handle()

get_db_handle ( )

abstractprotected

Gets db handle currently used with queries.

Return values

resource

◆ get_default_home_page()

get_default_home_page ( )

Returns the default home page to display if current one is not defined or can't be applied.

The default behaviour is to return Dashboard if it's enabled or My courses page if it isn't.

Return values

int	The default home page.

◆ get_device_cfg_var_name()

get_device_cfg_var_name ( )

Deprecated: since 2.6

◆ get_device_type()

get_device_type ( )

Deprecated: since 2.6

◆ get_device_type_list()

get_device_type_list ( )

Deprecated: since 2.6

◆ get_directory_list()

get_directory_list	(	$rootdir,
		$excludefiles = '',
		$descend = true,
		$getdirs = false,
		$getfiles = true )

Returns an array with all the filenames in all subdirectories, relative to the given rootdir.

If excludefiles is defined, then that file/directory is ignored If getdirs is true, then (sub)directories are included in the output If getfiles is true, then files are included in the output (at least one of these must be true!)

Todo: Finish documenting this function. Add examples of $excludefile usage.

Parameters

string	$rootdir	A given root directory to start from
string \| array	$excludefiles	If defined then the specified file/directory is ignored
bool	$descend	If true then subdirectories are recursed as well
bool	$getdirs	If true then (sub)directories are included in the output
bool	$getfiles	If true then files are included in the output

Return values

array An array with all the filenames in all subdirectories, relative to the given rootdir

◆ get_directory_size()

get_directory_size	(		$rootdir,
			$excludefile = '' )

Adds up all the files in a directory and works out the size.

Parameters

string	$rootdir	The directory to start from
string	$excludefile	A file to exclude when summing directory size

Return values

int	The summed size of all files and subfiles within the root directory

◆ get_docs_url()

get_docs_url ( $path = null )

Returns the Moodle Docs URL in the users language for a given 'More help' link.

There are three cases:

In the normal case, $path will be a short relative path 'component/thing', like 'mod/folder/view' 'group/import'. This gets turned into an link to MoodleDocs in the user's language, and for the appropriate Moodle version. E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'. The 'http://docs.moodle.org' bit comes from $CFG->docroot.

This is the only option that should be used in standard Moodle code. The other two options have been implemented because they are useful for third-party plugins.

$path may be an absolute URL, starting http:// or https://. In this case, the link is used as is.
$path may start %WWWROOT%%, in which case that is replaced by $CFG->wwwroot to make the link.

Parameters

string $path the place to link to. See above for details.

Return values

string The MoodleDocs URL in the user's language. for example $path}

◆ get_emoticon_manager()

get_emoticon_manager ( )

Factory function for emoticon_manager.

Return values

emoticon_manager singleton

◆ get_enabled_auth_plugins()

get_enabled_auth_plugins ( $fix = false )

Returns array of active auth plugins.

Parameters

bool $fix fix $CFG->auth if needed. Only set if logged in as admin.

Return values

array

◆ get_enrolled_join()

get_enrolled_join	(	context	$context,
			$useridcolumn,
			$onlyactive = false,
			$onlysuspended = false,
			$enrolid = 0 )

Returns array with sql joins and parameters returning all ids of users enrolled into course.

This function is using 'ej[0-9]+_' prefix for table names and parameters.

Exceptions

Parameters

context	$context
string	$useridcolumn	User id column used the calling query, e.g. u.id
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions
bool	$onlysuspended	inverse of onlyactive, consider only suspended enrolments
int	$enrolid	The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned.

Return values

core\dml\sql_join Contains joins, wheres, params

◆ get_enrolled_sql()

get_enrolled_sql	(	context	$context,
			$withcapability = '',
			$groupids = 0,
			$onlyactive = false,
			$onlysuspended = false,
			$enrolid = 0 )

Returns array with sql code and parameters returning all ids of users enrolled into course.

This function is using 'eu[0-9]+_' prefix for table names and parameters.

Parameters

context	$context
string	$withcapability
int \| array	$groupids	The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions
bool	$onlysuspended	inverse of onlyactive, consider only suspended enrolments
int	$enrolid	The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned.

Return values

array list($sql, $params)

◆ get_enrolled_users()

get_enrolled_users	(	context	$context,
			$withcapability = '',
			$groupids = 0,
			$userfields = 'u.*',
			$orderby = null,
			$limitfrom = 0,
			$limitnum = 0,
			$onlyactive = false )

Returns list of users enrolled into course.

Parameters

context	$context
string	$withcapability
int \| array	$groupids	The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group
string	$userfields	requested user record fields
string	$orderby
int	$limitfrom	return a subset of records, starting at this point (optional, required if $limitnum is set).
int	$limitnum	return a subset comprising this many records (optional, required if $limitfrom is set).
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions

Return values

array of user records

◆ get_enrolled_with_capabilities_join()

get_enrolled_with_capabilities_join	(	context	$context,
			$prefix = '',
			$capability = '',
			$groupids = 0,
			$onlyactive = false,
			$onlysuspended = false,
			$enrolid = 0 )

Returns an array of joins, wheres and params that will limit the group of users to only those enrolled and with given capability (if specified).

Note this join will return duplicate rows for users who have been enrolled several times (e.g. as manual enrolment, and as self enrolment). You may need to use a SELECT DISTINCT in your query (see get_enrolled_sql for example).

In case is guaranteed some of the joins never match any rows, the resulting join_sql->cannotmatchanyrows will be true. This happens when the capability is prohibited.

Parameters

context	$context
string	$prefix	optional, a prefix to the user id column
string \| array	$capability	optional, may include a capability name, or array of names. If an array is provided then this is the equivalent of a logical 'OR', i.e. the user needs to have one of these capabilities.
int \| array	$groupids	The groupids, 0 or [] means all groups and USERSWITHOUTGROUP no group
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions
bool	$onlysuspended	inverse of onlyactive, consider only suspended enrolments
int	$enrolid	The enrolment ID. If not 0, only users enrolled using this enrolment method will be returned.

Return values

core\dml\sql_join Contains joins, wheres, params and cannotmatchanyrows

◆ get_environment_for_version()

get_environment_for_version	(		$version,
			$env_select )

This function will return the xmlized data belonging to one Moodle version.

Parameters

string	$version	top version from which we start to look backwards
int \| string	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

mixed the xmlized structure or false on error

◆ get_exception_info()

get_exception_info ( $ex )

Returns detailed information about specified exception.

Parameters

Throwable $ex any sort of exception or throwable.

Return values

stdClass standardised info to display. Fields are clear if you look at the end of this function.

◆ get_extra_user_fields()

get_extra_user_fields	(		$context,
			$already = array() )

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

Does not include any custom profile fields.

Parameters

object	$context	Context
array	$already	Array of fields that we're going to show anyway so don't bother listing them

Return values

array Array of field names from user table, not including anything listed in $already

Deprecated: since Moodle 3.11 MDL-45242

See also: core_user\fields

◆ get_extra_user_fields_sql()

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

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.

Parameters

context	$context	Context
string	$alias	Alias of user table, e.g. 'u' (default none)
string	$prefix	Prefix for field names using AS, e.g. 'u_' (default none)
array	$already	Array of fields that we're going to include anyway so don't list them (default none)

Return values

string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank

Deprecated: since Moodle 3.11 MDL-45242

See also: core_user\fields

◆ get_fast_modinfo()

get_fast_modinfo	(	$courseorid,
		$userid = 0,
		$resetonly = false )

Returns reference to full info about modules in course (including visibility).

Cached and as fast as possible (0 or 1 db query).

use get_fast_modinfo($courseid, 0, true) to reset the static cache for particular course use get_fast_modinfo(0, 0, true) to reset the static cache for all courses

use rebuild_course_cache($courseid, true) to reset the application AND static cache for particular course when it's contents has changed

Parameters

int \| stdClass	$courseorid	object from DB table 'course' (must have field 'id' and recommended to have field 'cacherev') or just a course id. Just course id is enough when calling get_fast_modinfo() for current course or site or when calling for any other course for the second time.
int	$userid	User id to populate 'availble' and 'uservisible' attributes of modules and sections. Set to 0 for current user (default). Set to -1 to avoid calculation of dynamic user-depended data.
bool	$resetonly	whether we want to get modinfo or just reset the cache

Return values

course_modinfo|null Module information for course, or null if resetting

Exceptions

moodle_exception when course is not found (nothing is thrown if resetting)

◆ get_file_argument()

get_file_argument ( )

Extracts file argument either from file parameter or PATH_INFO.

Note: $scriptname parameter is not needed anymore

Return values

string file path (only safe characters)

◆ get_file_browser()

get_file_browser ( )

Returns local file storage instance.

Return values

file_browser

◆ get_file_packer()

get_file_packer ( $mimetype = 'application/zip' )

Returns file packer.

Parameters

string $mimetype default application/zip

Return values

file_packer

◆ get_file_storage()

get_file_storage ( $reset = false )

Returns local file storage instance.

Return values

file_storage

◆ get_file_url()

get_file_url ( )

Deprecated: since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example: The moodle_url\make_legacyfile_url() method can be used to generate a legacy course file url. To generate course module file.php url the moodle_url\make_file_url() should be used.

◆ get_formatted_help_string()

get_formatted_help_string	(	$identifier,
		$component,
		$ajax = false,
		$a = null )

Get the value of a help string fully prepared for display in the current language.

Parameters

string	$identifier	The identifier of the string to search for.
string	$component	The module the string is associated with.
boolean	$ajax	Whether this help is called from an AJAX script. This is used to influence text formatting and determines which format to output the doclink in.
string \| object \| array	$a	An object, string or number that can be used within translation strings

Return values

stdClass

An object containing:

heading: Any heading that there may be for this help string.
text: The wiki-formatted help string.
doclink: An object containing a link, the linktext, and any additional CSS classes to apply to that link. Only present if $ajax = false.
completedoclink: A text representation of the doclink. Only present if $ajax = true.

◆ get_generic_section_name()

get_generic_section_name ( )

Deprecated: since 2.4

◆ get_google_client()

get_google_client ( )

Wrapper to get a Google Client object.

This automatically sets the config to Moodle's defaults.

Return values

Google_Client

◆ get_group_picture_url()

get_group_picture_url	(	$group,
		$courseid,
		$large = false,
		$includetoken = false )

Return the url to the group picture.

Parameters

stdClass	$group	A group object.
int	$courseid	The course ID for the group.
bool	$large	A large or small group picture? Default is small.
boolean	$includetoken	Whether to use a user token when displaying this group image. True indicates to generate a token for current user, and integer value indicates to generate a token for the user whose id is the value indicated. If the group picture is included in an e-mail or some other location where the audience is a specific user who will not be logged in when viewing, then we use a token to authenticate the user.

Return values

moodle_url Returns the url for the group picture.

◆ get_home_page()

get_home_page ( )

Gets the homepage to use for the current user.

Return values

int	One of HOMEPAGE_*

◆ get_host_from_url()

get_host_from_url ( $url )

Returns host part from url.

Parameters

string $url full url

Return values

string host, null if not found

◆ get_html_lang()

get_html_lang ( $dir = false )

Return a string containing 'lang', xml:lang and optionally 'dir' HTML attributes.

Internationalisation, for print_header and backup/restorelib.

Parameters

bool $dir Default false

Return values

string Attributes

◆ get_html_lang_attribute_value()

get_html_lang_attribute_value ( string $langcode )

Converts a language code to hyphen-separated format in accordance to the BCP47 syntax.

For additional information, check out MDN web docs - lang.

Parameters

string $langcode The language code to convert.

Return values

string

◆ get_import_export_formats()

get_import_export_formats ( $type )

Get list of available import or export formats.

Parameters

string $type 'import' if import list, otherwise export list assumed

Return values

array sorted list of import/export formats available

◆ get_latest_version_available()

get_latest_version_available	(		$version,
			$env_select )

This function will return the most recent version in the environment.xml file previous or equal to the version requested.

Parameters

string	$version	top version from which we start to look backwards
int	$env_select	one of ENV_SELECT_NEWER \| ENV_SELECT_DATAROOT \| ENV_SELECT_RELEASE decide xml to use.

Return values

string|bool string more recent version or false if not found

◆ get_level()

get_level ( $element )

Here all the restrict functions are coded to be used by the environment checker.

All those functions will receive the result object and will return it modified as needed (status and bypass string)

Parameters

array $element the element from the environment.xml file that should have either a level="required" or level="optional" attribute.

Return values

string "required" or "optional".

◆ get_list_of_charsets()

get_list_of_charsets ( )

Returns a list of charset codes.

Returns a list of charset codes. It's hardcoded, so they should be added manually (checking that such charset is supported by the texlib library!)

Return values

array And associative array with contents in the form of charset => charset

◆ get_list_of_environment_versions()

get_list_of_environment_versions ( $contents )

This function will return the list of Moodle versions available.

Return values

array of versions

◆ get_list_of_plugins()

get_list_of_plugins	(	$directory = 'mod',
		$exclude = '',
		$basedir = '' )

Lists plugin-like directories within specified directory.

This function was originally used for standard Moodle plugins, please use new core_component\get_plugin_list() now.

This function is used for general directory listing and backwards compatility.

Parameters

string	$directory	relative directory from root
string	$exclude	dir name to exclude from the list (defaults to none)
string	$basedir	full path to the base dir where $plugin resides (defaults to $CFG->dirroot)

Return values

array Sorted array of directory names found under the requested parameters

◆ get_list_of_themes()

get_list_of_themes ( )

Returns a list of valid and compatible themes.

Return values

array

◆ get_list_of_timezones()

get_list_of_timezones ( )

Deprecated: since Moodle 2.9

◆ get_local_referer()

get_local_referer ( $stripquery = true )

Returns the cleaned local URL of the HTTP_REFERER less the URL query string parameters if required.

Parameters

bool $stripquery if true, also removes the query part of the url.

Return values

string The resulting referer or empty string.

◆ get_log_manager()

get_log_manager ( $forcereload = false )

LOG FUNCTIONS /////////////////////////////////////////////////////.

Get instance of log manager.

Parameters

bool $forcereload

Return values

core\log\manager

◆ get_login_url()

get_login_url ( )

Returns full login url.

Any form submissions for authentication to this URL must include username, password as well as a logintoken generated by core\session\manager\get_login_token().

Return values

string login url

◆ get_logs()

get_logs ( )

Deprecated: since Moodle 3.2

◆ get_logs_usercourse()

get_logs_usercourse ( )

Deprecated: since Moodle 3.2

◆ get_logs_userday()

get_logs_userday ( )

Deprecated: since Moodle 3.2

◆ get_mailer()

get_mailer ( $action = 'get' )

Get mailer instance, enable buffering, flush buffer or disable buffering.

Parameters

string $action 'get', 'buffer', 'close' or 'flush'

Return values

moodle_phpmailer|null mailer instance if 'get' used or nothing

◆ get_max_courses_in_category()

get_max_courses_in_category ( )

Return maximum number of courses in a category.

@uses MAX_COURSES_IN_CATEGORY

Return values

int	number of courses

◆ get_max_upload_file_size()

get_max_upload_file_size	(	$sitebytes = 0,
		$coursebytes = 0,
		$modulebytes = 0,
		$unused = false )

Returns the maximum size for uploading files.

There are seven possible upload limits:

in Apache using LimitRequestBody (no way of checking or changing this)
in php.ini for 'upload_max_filesize' (can not be changed inside PHP)
in .htaccess for 'upload_max_filesize' (can not be changed inside PHP)
in php.ini for 'post_max_size' (can not be changed inside PHP)
by the Moodle admin in $CFG->maxbytes
by the teacher in the current course $course->maxbytes
by the teacher for the current module, eg $assignment->maxbytes

These last two are passed to this function as arguments (in bytes). Anything defined as 0 is ignored. The smallest of all the non-zero numbers is returned.

Todo: Finish documenting this function

Parameters

int	$sitebytes	Set maximum size
int	$coursebytes	Current course $course->maxbytes (in bytes)
int	$modulebytes	Current module ->maxbytes (in bytes)
bool	$unused	This parameter has been deprecated and is not used any more.

Return values

int	The maximum size for uploading files.

◆ get_max_upload_sizes()

get_max_upload_sizes	(	$sitebytes = 0,
		$coursebytes = 0,
		$modulebytes = 0,
		$custombytes = null )

Returns an array of possible sizes in local language.

Related to get_max_upload_file_size() - this function returns an array of possible sizes in an array, translated to the local language.

The list of options will go up to the minimum of $sitebytes, $coursebytes or $modulebytes.

If $coursebytes or $sitebytes is not 0, an option will be included for "Course/Site upload limit (X)" with the value set to 0. This option will be the first in the list.

@uses SORT_NUMERIC

Parameters

int	$sitebytes	Set maximum size
int	$coursebytes	Current course $course->maxbytes (in bytes)
int	$modulebytes	Current module ->maxbytes (in bytes)
int \| array	$custombytes	custom upload size/s which will be added to list, Only value/s smaller then maxsize will be added to list.

Return values

array

◆ get_mnet_environment()

get_mnet_environment ( )

helper function to load up and initialise the mnet environment this must be called before you use mnet functions.

Return values

mnet_environment the equivalent of old $MNET global

◆ get_mnet_remote_client()

get_mnet_remote_client ( )

during xmlrpc server code execution, any code wishing to access information about the remote peer must use this to get it.

Return values

mnet_remote_client the equivalent of old $MNETREMOTE_CLIENT global

◆ get_module_metadata()

get_module_metadata ( )

Deprecated: since 3.9

◆ get_moodle_cookie()

get_moodle_cookie ( )

Gets a moodle cookie with a weakly encrypted username.

Return values

string username

◆ get_my_remotecourses()

object get_my_remotecourses ( $userid = 0 )

List of remote courses that a user has access to via MNET.

Works only on the IDP

@global object

Parameters

int	@userid The user id to get remote courses for

Return values

array Array of $COURSE of course objects

◆ get_my_remotehosts()

object get_my_remotehosts ( )

List of remote hosts that a user has access to via MNET.

Works on the SP

@global object

Return values

array|bool Array of host objects or false

◆ get_newuser_language()

get_newuser_language ( )

Returns the string of the language for the new user.

Return values

string language for the new user

◆ get_next_version()

get_next_version ( int $questionbankentryid )

Get the next version number to create base on a Question bank entry id.

Parameters

int $questionbankentryid Question bank entry id.

Return values

int	next version number.

Exceptions

◆ get_other_mapping()

static core\event\get_other_mapping ( )

static

Used for maping events on restore.

Return values

bool

◆ get_parent_contextid()

get_parent_contextid ( )

Deprecated: since Moodle 2.2

◆ get_parent_contexts()

get_parent_contexts ( )

Deprecated: since 2.2, use $context->get_parent_context_ids() instead

◆ get_parent_language()

get_parent_language ( $lang = null )

Returns parent language of current active language if defined.

Parameters

string $lang null means current language

Return values

string

◆ get_performance_info()

get_performance_info ( )

get_performance_info() pairs up with init_performance_info() loaded in setup.php.

Returns an array with 'html' and 'txt' values ready for use, and each of the individual stats provided separately as well.

Return values

array

◆ get_performance_summary()

performance_measuring_filter_manager::get_performance_summary ( )

Return performance information, in the form required by get_performance_info().

Return values

array the performance info.

◆ get_plugin_directory()

get_plugin_directory	(		$plugintype,
			$name )

static

Returns the exact absolute path to plugin directory.

Parameters

string	$plugintype	type of plugin
string	$pluginname	name of the plugin

Return values

string full path to plugin directory; null if not found

Deprecated: since 2.6, use core_component\get_plugin_directory()

Parameters

string	$plugintype	type of plugin
string	$name	name of the plugin

Return values

string full path to plugin directory; NULL if not found

◆ get_plugin_list()

get_plugin_list ( $plugintype )

static

Get list of plugins of given type.

Use when listing real plugins of one type.

Parameters

string $plugintype

Return values

array as (string)pluginname => (string)fulldir

Deprecated: since 2.6, use core_component\get_plugin_list()

Parameters

string $plugintype type of plugin

Return values

array name=>fulllocation pairs of plugins of given type

◆ get_plugin_list_with_class()

get_plugin_list_with_class	(	$plugintype,
		$class,
		$file = null )

static

Get a list of all the plugins of a given type that define a certain class in a certain file.

The plugin component names and class names are returned.

Parameters

string	$plugintype	the type of plugin, e.g. 'mod' or 'report'.
string	$class	the part of the name of the class after the frankenstyle prefix. e.g 'thing' if you are looking for classes with names like report_courselist_thing. If you are looking for classes with the same name as the plugin name (e.g. qtype_multichoice) then pass ''. Frankenstyle namespaces are also supported.
string	$file	the name of file within the plugin that defines the class.

Return values

array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum') and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').

The plugin component names and class names are returned.

Deprecated: since 2.6, use core_component\get_plugin_list_with_class()

Parameters

string	$plugintype	the type of plugin, e.g. 'mod' or 'report'.
string	$class	the part of the name of the class after the frankenstyle prefix. e.g 'thing' if you are looking for classes with names like report_courselist_thing. If you are looking for classes with the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
string	$file	the name of file within the plugin that defines the class.

Return values

array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum') and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').

◆ get_plugin_list_with_file() [1/2]

static get_plugin_list_with_file	(	$plugintype,
		$file,
		$include = false )

static

Get a list of all the plugins of a given type that contain a particular file.

Parameters

string	$plugintype	the type of plugin, e.g. 'mod' or 'report'.
string	$file	the name of file that must be present in the plugin. (e.g. 'view.php', 'db/install.xml').
bool	$include	if true (default false), the file will be include_once-ed if found.

Return values

array with plugin name as keys (e.g. 'forum', 'courselist') and the path to the file relative to dirroot as value (e.g. "$CFG->dirroot/mod/forum/view.php").

◆ get_plugin_list_with_file() [2/2]

get_plugin_list_with_file ( )

Deprecated: since 2.6

◆ get_plugin_list_with_function()

get_plugin_list_with_function	(	$plugintype,
		$function,
		$file = 'lib.php' )

Get a list of all the plugins of a given type that define a certain API function in a certain file.

The plugin component names and function names are returned.

Parameters

string	$plugintype	the type of plugin, e.g. 'mod' or 'report'.
string	$function	the part of the name of the function after the frankenstyle prefix. e.g 'hook' if you are looking for functions with names like report_courselist_hook.
string	$file	the name of file within the plugin that defines the function. Defaults to lib.php.

Return values

array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum') and the function names as values (e.g. 'report_courselist_hook', 'forum_hook').

◆ get_plugin_types() [1/2]

get_plugin_types ( $fullpaths = true )

Lists all plugin types.

Deprecated: since 2.6, use core_component\get_plugin_types()

Parameters

bool $fullpaths false means relative paths from dirroot

Return values

array Array of strings - name=>location

◆ get_plugin_types() [2/2]

static get_plugin_types ( )

static

Get list of available plugin types together with their location.

Return values

array as (string)plugintype => (string)fulldir

◆ get_plugin_types_with_subplugins()

static get_plugin_types_with_subplugins ( )

static

Returns list of plugin types that allow subplugins.

Return values

array as (string)plugintype => (string)fulldir

◆ get_plugins_with_function()

get_plugins_with_function	(	$function,
		$file = 'lib.php',
		$include = true )

Get a list of all the plugins that define a certain API function in a certain file.

Parameters

string	$function	the part of the name of the function after the frankenstyle prefix. e.g 'hook' if you are looking for functions with names like report_courselist_hook.
string	$file	the name of file within the plugin that defines the function. Defaults to lib.php.
bool	$include	Whether to include the files that contain the functions or not.

Return values

array with [plugintype][plugin] = functionname

◆ get_print_section_cm_text()

get_print_section_cm_text ( )

Deprecated: since 2.5

◆ get_question_bank_entry()

get_question_bank_entry ( int $questionid )

Get the question_bank_entry object given a question id.

Parameters

int $questionid Question id.

Return values

false|mixed

Exceptions

◆ get_question_options()

get_question_options	(	&	$questions,
			$loadtags = false,
			$filtercourses = null )

Updates the question objects with question type specific information by calling {.

See also: get_question_options()}

Can be called either with an array of question objects or with a single question object.

Parameters

mixed	$questions	Either an array of question objects to be updated or just a single question object
bool	$loadtags	load the question tags from the tags table. Optional, default false.
stdClass[]	$filtercourses	The courses to filter the course tags by.

Return values

bool	Indicates success or failure.

◆ get_question_version()

get_question_version ( $questionid )

Get the question versions given a question id in a descending sort .

Parameters

int $questionid Question id.

Return values

array

Exceptions

◆ get_real_size()

get_real_size ( $size = 0 )

Converts numbers like 10M into bytes.

Parameters

string $size The size to be converted

Return values

int

◆ get_recent_enrolments()

get_recent_enrolments ( )

Deprecated

◆ get_records_csv()

get_records_csv ( )

Deprecated: since Moodle 3.2

See also: csv_import_reader\load_csv_content()

◆ get_referer()

get_referer ( )

Deprecated: since Moodle 3.0 MDL-49360 - please do not use this function any more.

◆ get_related_contexts_string()

get_related_contexts_string ( )

Deprecated: since 2.2

◆ get_request_storage_directory()

get_request_storage_directory	(		$exceptiononerror = true,
		bool	$forcecreate = false )

Get a per-request storage directory in the tempdir.

The directory is automatically cleaned up during the shutdown handler.

Parameters

bool	$exceptiononerror	throw exception if error encountered
bool	$forcecreate	Force creation of a new parent directory

Return values

string Returns full path to directory if successful, false if not; may throw exception

◆ get_role_context_caps()

get_role_context_caps ( )

Deprecated: since Moodle 2.2

◆ get_roles_on_exact_context()

get_roles_on_exact_context ( )

Deprecated: since Moodle 3.6. Please use the get_roles_used_in_context().

◆ get_roles_with_assignment_on_context()

get_roles_with_assignment_on_context ( )

Deprecated: since Moodle 3.6. Please use the get_roles_used_in_context().

◆ get_safe_orderby()

get_safe_orderby	(	array	$orderbymap,
		string	$orderbykey,
		string	$direction = '',
		bool	$useprefix = true )

Prepare a safe ORDER BY statement from user interactable requests.

This allows safe user specified sorting (ORDER BY), by abstracting the SQL from the value being requested by the user. A standard string (and optional direction) can be specified, which will be mapped to a predefined allow list of SQL ordering. The mapping can optionally include a 'default', which will be used if the key provided is invalid.

Example usage: -If $orderbymap = [ 'courseid' => 'c.id', 'somecustomvalue'=> 'c.startdate, c.shortname', 'default' => 'c.fullname', ] -A value from the map array's keys can be passed in by a user interaction (eg web service) along with an optional direction. -get_safe_orderby($orderbymap, 'courseid', 'DESC') would return: ORDER BY c.id DESC -get_safe_orderby($orderbymap, 'somecustomvalue') would return: ORDER BY c.startdate, c.shortname -get_safe_orderby($orderbymap, 'invalidblah', 'DESC') would return: ORDER BY c.fullname DESC -If no default key was specified in $orderbymap, the invalidblah example above would return empty string.

Parameters

array	$orderbymap	An array in the format [keystring => sqlstring]. A default fallback can be set with the key 'default'.
string	$orderbykey	A string to be mapped to a key in $orderbymap.
string	$direction	Optional ORDER BY direction (ASC/DESC, case insensitive).
bool	$useprefix	Whether ORDER BY is prefixed to the output (true by default). This should not be modified in most cases. It is included to enable get_safe_orderby_multiple() to use this function multiple times.

Return values

string The ORDER BY statement, or empty string if $orderbykey is invalid and no default is mapped.

◆ get_safe_orderby_multiple()

get_safe_orderby_multiple	(	array	$orderbymap,
		array	$orderbykeys,
		array	$directions = [] )

Prepare a safe ORDER BY statement from user interactable requests using multiple values.

This allows safe user specified sorting (ORDER BY) similar to get_safe_orderby(), but supports multiple keys and directions. This is useful in cases where combinations of columns are needed and/or each item requires a specified direction (ASC/DESC). The mapping can optionally include a 'default', which will be used if the key provided is invalid.

Example usage: -If $orderbymap = [ 'courseid' => 'c.id', 'fullname'=> 'c.fullname', 'default' => 'c.startdate', ] -An array of values from the map's keys can be passed in by a user interaction (eg web service), with optional directions. -get_safe_orderby($orderbymap, ['courseid', 'fullname'], ['DESC', 'ASC']) would return: ORDER BY c.id DESC, c.fullname ASC -get_safe_orderby($orderbymap, ['courseid', 'invalidblah'], ['aaa', 'DESC']) would return: ORDER BY c.id, c.startdate DESC -If no default key was specified in $orderbymap, the invalidblah example above would return: ORDER BY c.id

Parameters

array	$orderbymap	An array in the format [keystring => sqlstring]. A default fallback can be set with the key 'default'.
array	$orderbykeys	An array of strings to be mapped to keys in $orderbymap.
array	$directions	Optional array of ORDER BY direction (ASC/DESC, case insensitive). The array keys should match array keys in $orderbykeys.

Return values

string The ORDER BY statement, or empty string if $orderbykeys contains no valid items and no default is mapped.

◆ get_scales_menu()

object get_scales_menu ( $courseid = 0 )

Returns a menu of all available scales from the site as well as the given course.

Parameters

int $courseid The id of the course as found in the 'course' table.

Return values

array

◆ get_selected_theme_for_device_type()

get_selected_theme_for_device_type ( )

Deprecated: since 2.6

◆ get_separator()

get_separator ( )

Return the breadcrumb trail navigation separator.

Return values

string HTML string.

◆ get_site()

get_site ( )

OTHER SITE AND COURSE FUNCTIONS /////////////////////////////////////////////.

Returns $course object of the top-level site.

Return values

object A $COURSE object for the site, exception if not found

◆ get_site_identifier()

get_site_identifier ( )

Returns the site identifier.

Return values

string\$CFG-,>siteidentifier,first making sure it is properly initialised.

◆ get_string()

get_string	(	$identifier,
		$component = '',
		$a = null,
		$lazyload = false )

Returns a localized string.

Returns the translated string specified by $identifier as for $module. Uses the same format files as STphp. $a is an object, string or number that can be used within translation strings

eg 'hello {$a->firstname} {$a->lastname}' or 'hello {$a}'

If you would like to directly echo the localized string use the function print_string()

Example usage of this function involves finding the string you would like a local equivalent of and using its identifier and module information to retrieve it.
If you open moodle/lang/en/moodle.php and look near line 278 you will find a string to prompt a user for their word for 'course' $string['course'] = 'Course'; So if you want to display the string 'Course' in any language that supports it on your site you just need to use the identifier 'course' $mystring = ''. get_string('course') .''; or If the string you want is in another file you'd take a slightly different approach. Looking in moodle/lang/en/calendar.php you find around line 75: $string['typecourse'] = 'Course event'; If you want to display the string "Course event" in any language supported you would use the identifier 'typecourse' and the module 'calendar' (because it is in the file calendar.php): $mystring = '

`'. get_string('typecourse', 'calendar') .'`

';

As a last resort, should the identifier fail to map to a string the returned string will be [[ $identifier ]]

In Moodle 2.3 there is a new argument to this function $lazyload. Setting $lazyload to true causes get_string to return a lang_string object rather than the string itself. The fetching of the string is then put off until the string object is first used. The object can be used by calling it's out method or by casting the object to a string, either directly e.g. (string)$stringobject or indirectly by using the string within another string or echoing it out e.g. echo $stringobject return "<p>{$stringobject}</p>"; It is worth noting that using $lazyload and attempting to use the string as an array key will cause a fatal error as objects cannot be used as array keys. But you should never do that anyway! For more information lang_string

Parameters

string	$identifier	The key identifier for the localized string
string	$component	The module where the key identifier is stored, usually expressed as the filename in the language pack without the .php on the end but can also be written as mod/forum or grade/export/xls. If none is specified then moodle.php is used.
string \| object \| array \| int	$a	An object, string or number that can be used within translation strings
bool	$lazyload	If set to true a string object is returned instead of the string itself. The string then isn't calculated until it is first used.

Return values

string The localized string.

Exceptions

◆ get_string_filters()

filter_manager::get_string_filters ( $context )

protected

Get all the filters that apply to a given context for calls to format_string.

Parameters

context $context the context.

Return values

moodle_text_filter[] A text filter

◆ get_string_manager()

get_string_manager ( $forcereload = false )

Returns current string_manager instance.

The param $forcereload is needed for CLI installer only where the string_manager instance must be replaced during the install.php script life time.

Parameters

bool $forcereload shall the singleton be released and new instance created instead?

Return values

core_string_manager

◆ get_strings()

get_strings	(		$array,
			$component = '' )

Converts an array of strings to their localized value.

Parameters

array	$array	An array of strings
string	$component	The language module that these strings can be found in.

Return values

stdClass translated strings.

◆ get_subplugins()

static get_subplugins ( $component )

static

Return all subplugins of this component.

Parameters

string $component,.

Return values

array\$subtype,=>array($component,..),null if no subtypes defined

◆ get_subsystem_directory()

static get_subsystem_directory ( $subsystem )

static

Returns the exact absolute path to plugin directory.

Parameters

string $subsystem type of core subsystem

Return values

string full path to subsystem directory; null if not found

◆ get_subtype_parent()

static get_subtype_parent ( $type )

static

Returns parent of this subplugin type.

Parameters

string $type

Return values

string parent component or null

◆ get_system_context()

get_system_context ( $cache = true )

Returns system context or null if can not be created yet.

See also: context_system\instance()

Deprecated: since 2.2

Parameters

bool $cache use caching

Return values

context system context (null if context table not created yet)

◆ get_text_filters()

filter_manager::get_text_filters ( $context )

protected

Get all the filters that apply to a given context for calls to format_text.

Parameters

context $context

Return values

moodle_text_filter[] A text filter

◆ get_texteditor()

get_texteditor ( $editorname )

Returns instance of text editor.

Parameters

string $editorname name of editor (textarea, tiny, ...)

Return values

object|bool texeditor instance or false if does not exist

◆ get_time_interval_string()

get_time_interval_string	(	int	$time1,
		int	$time2,
		string	$format = '' )

Get a formatted string representation of an interval between two unix timestamps.

E.g. $intervalstring = get_time_interval_string(12345600, 12345660); Will produce the string: '0d 0h 1m'

Parameters

int	$time1	unix timestamp
int	$time2	unix timestamp
string	$format	string (can be lang string) containing format chars: https://www.php.net/manual/en/dateinterval.format.php.

Return values

string the formatted string describing the time difference, e.g. '10d 11h 45m'.

◆ get_timezone_offset()

get_timezone_offset ( )

Deprecated: since Moodle 2.9

◆ get_timezone_record()

get_timezone_record ( )

Deprecated: since Moodle 2.9

◆ get_trace()

core\task\get_trace ( )

protected

Get the progress_trace.

Return values

progress_trace

◆ get_used_table_names()

get_used_table_names ( )

Returns names of all known tables == tables that moodle knows about.

Return values

array Array of lowercase table names

◆ get_user_access_sitewide()

get_user_access_sitewide ( )

Deprecated: since Moodle 3.4. MDL-49398.

◆ get_user_courses_bycap()

get_user_courses_bycap ( )

Deprecated: since 2.2

◆ get_user_device_type()

get_user_device_type ( )

Deprecated: since 2.6

◆ get_user_field_name()

get_user_field_name ( $field )

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.

Parameters

string $field Field name, e.g. 'phone1'

Return values

string Text description taken from language file, e.g. 'Phone number'

Deprecated: since Moodle 3.11 MDL-45242

See also: core_user\fields

◆ get_user_fieldnames()

get_user_fieldnames ( )

Returns an array of user fields.

Return values

array User field/column names

◆ get_user_key()

get_user_key	(	$script,
		$userid,
		$instance = null,
		$iprestriction = null,
		$validuntil = null )

Gets a private user access key (and creates one if one doesn't exist).

Parameters

string	$script	unique target identifier
int	$userid
int	$instance	optional instance id
string	$iprestriction	optional ip restricted access
int	$validuntil	key valid only until given date

Return values

string access key value

◆ get_user_max_upload_file_size()

get_user_max_upload_file_size	(	$context,
		$sitebytes = 0,
		$coursebytes = 0,
		$modulebytes = 0,
		$user = null,
		$unused = false )

Returns the maximum size for uploading files for the current user.

This function takes in account get_max_upload_file_size() the user's capabilities

Parameters

context	$context	The context in which to check user capabilities
int	$sitebytes	Set maximum size
int	$coursebytes	Current course $course->maxbytes (in bytes)
int	$modulebytes	Current module ->maxbytes (in bytes)
stdClass	$user	The user
bool	$unused	This parameter has been deprecated and is not used any more.

Return values

int	The maximum size for uploading files.

◆ get_user_preferences()

get_user_preferences	(	$name = null,
		$default = null,
		$user = null )

Used to fetch user preference(s)

If no arguments are supplied this function will return all of the current user preferences as an array.

If a name is specified then this function attempts to return that particular preference value. If none is found, then the optional value $default is returned, otherwise null.

If a $user object is submitted it's 'preference' property is used for the preferences cache.

Parameters

string	$name	Name of the key to use in finding a preference value
mixed \| null	$default	Value to be returned if the $name key is not set in the user preferences
stdClass \| int \| null	$user	A moodle user object or id, null means current user

Exceptions

Return values

string|mixed|null A string containing the value of a single preference. An array with all of the preferences or null

◆ get_user_timezone()

get_user_timezone ( $tz = 99 )

Returns a float or a string which denotes the user's timezone A float value means that a simple offset from GMT is used, while a string (it will be the name of a timezone in the database) means that for this timezone there are also DST rules to be taken into account Checks various settings and picks the most dominant of those which have a value.

Parameters

float | int | string $tz timezone to calculate GMT time offset before calculating user timezone, 99 is default user timezone

Return values

float|string

◆ get_user_timezone_offset()

get_user_timezone_offset ( )

Deprecated: since Moodle 2.9

◆ get_users()

object get_users	(		$get = true,
			$search = '',
			$confirmed = false,
		array	$exceptions = null,
			$sort = 'firstname ASC',
			$firstinitial = '',
			$lastinitial = '',
			$page = '',
			$recordsperpage = '',
			$fields = '*',
			$extraselect = '',
		array	$extraparams = null )

Returns a subset of users.

@uses DEBUG_DEVELOPER @uses SQL_PARAMS_NAMED

Parameters

bool	$get	If false then only a count of the records is returned
string	$search	A simple string to search for
bool	$confirmed	A switch to allow/disallow unconfirmed users
array	$exceptions	A list of IDs to ignore, eg 2,4,5,8,9,10
string	$sort	A SQL snippet for the sorting criteria to use
string	$firstinitial	Users whose first name starts with $firstinitial
string	$lastinitial	Users whose last name starts with $lastinitial
string	$page	The page or records to return
string	$recordsperpage	The number of records to return per page
string	$fields	A comma separated list of fields to be returned from the chosen table.

Return values

array|int|bool $USER records unless get is false in which case the integer count of the records found is returned. False is returned if an error is encountered.

◆ get_users_confirmed()

object get_users_confirmed ( )

Full list of users that have confirmed their accounts.

Return values

array of unconfirmed users

◆ get_users_from_config()

get_users_from_config	(	$value,
		$capability,
		$includeadmins = true )

Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.

All users are verified if they still have the necessary capability.

Parameters

string	$value	the value of the config setting.
string	$capability	the capability - must match the one passed to the admin_setting_users_with_capability constructor.
bool	$includeadmins	include administrators.

Return values

array of user objects.

◆ get_users_listing()

get_users_listing	(		$sort = 'lastaccess',
			$dir = 'ASC',
			$page = 0,
			$recordsperpage = 0,
			$search = '',
			$firstinitial = '',
			$lastinitial = '',
			$extraselect = '',
		array	$extraparams = null,
			$extracontext = null )

Return filtered (if provided) list of users in site, except guest and deleted users.

Parameters

string	$sort	An SQL field to sort by
string	$dir	The sort direction ASC\|DESC
int	$page	The page or records to return
int	$recordsperpage	The number of records to return per page
string	$search	A simple string to search for
string	$firstinitial	Users whose first name starts with $firstinitial
string	$lastinitial	Users whose last name starts with $lastinitial
string	$extraselect	An additional SQL select statement to append to the query
array	$extraparams	Additional parameters to use for the above $extraselect
stdClass	$extracontext	If specified, will include user 'extra fields' as appropriate for current user and given context

Return values

array Array of $USER records

◆ getremoteaddr()

getremoteaddr ( $default = '0.0.0.0' )

Returns most reliable client address.

Parameters

string $default If an address can't be determined, then return this

Return values

string The remote IP address

◆ getweek()

getweek	(		$startdate,
			$thedate )

Given dates in seconds, how many weeks is the date from startdate The first week is 1, the second 2 etc ...

Parameters

int	$startdate	Timestamp for the start date
int	$thedate	Timestamp for the end date

Return values

string

◆ grade_print_tabs()

grade_print_tabs	(	$active_type,
		$active_plugin,
		$plugin_info,
		$return = false )

Print grading plugin selection tab-based navigation.

Deprecated: since Moodle 4.0. Tabs navigation has been replaced with tertiary navigation.

Parameters

string	$active_type	type of plugin on current page - import, export, report or edit
string	$active_plugin	active plugin type - grader, user, cvs, ...
array	$plugin_info	Array of plugins
boolean	$return	return as string

Return values

nothing or string if $return true

◆ groupmode()

groupmode ( )

This means that cm_info\$groupmode should be ignored and cm_info\$coursegroupmode be used instead.

Deprecated: since Moodle 2.0 MDL-14617 - please do not use this function any more.

◆ groups_course_module_visible()

groups_course_module_visible ( )

Deprecated: Since Moodle 2.8

◆ groups_filter_users_by_course_module_visible()

groups_filter_users_by_course_module_visible ( )

Deprecated: Since Moodle 2.8

◆ groups_get_all_groups_for_courses()

groups_get_all_groups_for_courses ( )

Deprecated: since Moodle 3.6.

◆ guest_user()

guest_user ( )

Retrieve the guest user object.

Return values

stdClass A $USER object

◆ has_monologo_icon()

static has_monologo_icon	(	string	$plugintype,
		string	$pluginname )

static

Checks for the presence of monologo icons within a plugin.

Only checks monologo icons in PNG and SVG formats as they are formats that can have transparent background.

Parameters

string	$plugintype	The plugin type.
string	$pluginname	The plugin name.

Return values

bool	True if the plugin has a monologo icon

◆ hash()

moodle_text_filter::hash ( )

Deprecated: Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more.

◆ hash_internal_user_password()

hash_internal_user_password	(		$password,
			$fasthash = false )

Calculate hash for a plain text password.

Parameters

string	$password	Plain text password to be hashed.
bool	$fasthash	If true, use a low cost factor when generating the hash This is much faster to generate but makes the hash less secure. It is used when lots of hashes need to be generated quickly.

Return values

string The hashed password.

Exceptions

moodle_exception If a problem occurs while generating the hash.

◆ hash_local_config_cache()

hash_local_config_cache ( )

Calculate a proper hash to be able to invalidate stale cached configs.

Only to be used to verify bootstrap.php status.

Return values

string md5 hash of all the sensible bits deciding if cached config is stale or no.

◆ hide_event()

hide_event ( )

Deprecated: please use calendar_event->toggle_visibility(false) instead.

◆ highlight()

highlight	(	$needle,
		$haystack,
		$matchcase = false,
		$prefix = '<span class="highlight">',
		$suffix = '</span>' )

This function will highlight search words in a given string.

It cares about HTML and will not ruin links. It's best to use this function after performing any conversions to HTML.

Parameters

string	$needle	The search string. Syntax like "word1 +word2 -word3" is dealt with correctly.
string	$haystack	The string (HTML) within which to highlight the search terms.
boolean	$matchcase	whether to do case-sensitive. Default case-insensitive.
string	$prefix	the string to put before each search term found.
string	$suffix	the string to put after each search term found.

Return values

string The highlighted HTML.

◆ highlightfast()

highlightfast	(		$needle,
			$haystack )

This function will highlight instances of $needle in $haystack.

It's faster that the above function highlight() and doesn't care about HTML or anything.

Parameters

string	$needle	The string to search for
string	$haystack	The string to search for $needle in

Return values

string The highlighted HTML

◆ html_is_blank()

html_is_blank ( $string )

Tests whether anything was returned by text editor.

This function is useful for testing whether something you got back from the HTML editor actually contains anything. Sometimes the HTML editor appear to be empty, but actually you get back a
tag or something.

Parameters

string $string a string containing HTML.

Return values

boolean does the string contain any actual content - that is text, images, objects, etc.

◆ html_to_text()

html_to_text	(	$html,
		$width = 75,
		$dolinks = true )

Given HTML text, make it into plain text using external function.

Parameters

string	$html	The text to be converted.
integer	$width	Width to wrap the text at. (optional, default 75 which is a good value for email. 0 means do not limit line length.)
boolean	$dolinks	By default, any links in the HTML are collected, and printed as a list at the end of the HTML. If you don't want that, set this argument to false.

Return values

string plain text equivalent of the HTML.

◆ httpsrequired()

httpsrequired ( )

Deprecated: Loginhttps is no longer supported

◆ idnumber_exist_in_question_category()

idnumber_exist_in_question_category	(	$questionidnumber,
		$categoryid,
		$limitfrom = 0,
		$limitnum = 1 )

Check if an idnumber exist in the category.

Parameters

int	$questionidnumber
int	$categoryid
int	$limitfrom
int	$limitnum

Return values

array

◆ imagecopybicubic()

imagecopybicubic	(	$dst_img,
		$src_img,
		$dst_x,
		$dst_y,
		$src_x,
		$src_y,
		$dst_w,
		$dst_h,
		$src_w,
		$src_h )

Copies a rectangular portion of the source image to another rectangle in the destination image.

This function calls imagecopyresampled() if it is available and GD version is 2 at least. Otherwise it reimplements the same behaviour. See the PHP manual page for more info.

@externalurl http://php.net/manual/en/function.imagecopyresampled.php

Parameters

resource \| GdImage	$dst_img	the destination GD image resource
resource \| GdImage	$src_img	the source GD image resource
int	$dst_x	vthe X coordinate of the upper left corner in the destination image
int	$dst_y	the Y coordinate of the upper left corner in the destination image
int	$src_x	the X coordinate of the upper left corner in the source image
int	$src_y	the Y coordinate of the upper left corner in the source image
int	$dst_w	the width of the destination rectangle
int	$dst_h	the height of the destination rectangle
int	$src_w	the width of the source rectangle
int	$src_h	the height of the source rectangle

Return values

bool	tru on success, false otherwise

◆ in_object_vars()

in_object_vars	(		$var,
			$object )

Checks whether the given variable name is defined as a variable within the given object.

This will NOT work with stdClass objects, which have no class variables.

Parameters

string	$var	The variable name
object	$object	The object to check

Return values

boolean

◆ increment_revision_number()

increment_revision_number	(		$table,
			$field,
			$select,
		array	$params = null )

Increment standard revision field.

The revision are based on current time and are incrementing. There is a protection for runaway revisions, it may not go further than one hour into future.

The field has to be XMLDB_TYPE_INTEGER with size 10.

Parameters

string	$table
string	$field	name of the field containing revision
string	$select	use empty string when updating all records
array	$params	optional select parameters

◆ ini_get_bool()

ini_get_bool ( $ini_get_arg )

This function makes the return value of ini_get consistent if you are setting server directives through the .htaccess file in apache.

Current behavior for value set from php.ini On = 1, Off = [blank] Current behavior for value set from .htaccess On = On, Off = Off Contributed by jdell @ unr.edu

Parameters

string $ini_get_arg The argument to get

Return values

bool	True for on false for not

◆ init_performance_info()

init_performance_info ( )

Initializes our performance info early.

Pairs up with get_performance_info() which is actually in moodlelib.php. This function is here so that we can call it before all the libs are pulled in.

@uses $PERF

◆ initialise_fullme()

initialise_fullme ( )

Initialises $FULLME and friends.

Private function. Should only be called from setup.php.

◆ initialise_fullme_cli()

initialise_fullme_cli ( )

Initialises $FULLME and friends for command line scripts.

This is a private method for use by initialise_fullme.

◆ initialise_local_config_cache()

initialise_local_config_cache ( )

Cache any immutable config locally to avoid constant DB lookups.

Only to be used only from lib/setup.php

◆ install_cli_database()

install_cli_database	(	array	$options,
			$interactive )

Install Moodle DB, config.php must exist, there must not be any tables in db yet.

Parameters

array	$options	adminpass is mandatory
bool	$interactive

Return values

void

◆ install_core()

install_core	(		$version,
			$verbose )

Install core moodle tables and initialize.

Parameters

float	$version	target version
bool	$verbose

Return values

void,may throw exception

◆ install_db_validate()

install_db_validate	(	$database,
		$dbhost,
		$dbuser,
		$dbpass,
		$dbname,
		$prefix,
		$dboptions )

This is in function because we want the /install.php to parse in PHP4.

Parameters

object	$database
string	$dbhsot
string	$dbuser
string	$dbpass
string	$dbname
string	$prefix
mixed	$dboptions

Return values

string

◆ install_generate_configphp()

install_generate_configphp	(		$database,
			$cfg )

Returns content of config.php file.

Uses PHP_EOL for generating proper end of lines for the given platform.

Parameters

moodle_database	$database	database instance
object	$cfg	copy of $CFG

Return values

string

◆ install_guess_wwwroot()

install_guess_wwwroot ( )

Tries to detect the right www root setting.

Return values

string detected www root

◆ install_helpbutton()

install_helpbutton	(		$url,
			$title = '' )

Print help button.

Parameters

string	$url
string	$titel

Return values

void

◆ install_ini_get_bool()

install_ini_get_bool ( $ini_get_arg )

Copy of.

See also: {ini_get_bool()}

Parameters

string $ini_get_arg

Return values

bool

◆ install_init_dataroot()

install_init_dataroot	(		$dataroot,
			$dirpermissions )

Creates dataroot if not exists yet, makes sure it is writable, add lang directory and add .htaccess just in case it works.

Parameters

string	$dataroot	full path to dataroot
int	$dirpermissions

Return values

bool success

◆ install_print_footer()

object install_print_footer	(		$config,
			$reload = false )

Prints installation page header, we can not use weblib yet in installer.

Parameters

stdClass	$config
bool	$reload	print reload button instead of next

Return values

void

◆ install_print_header()

object install_print_header	(	$config,
		$stagename,
		$heading,
		$stagetext,
		$stageclass = "alert-info" )

Prints installation page header, we can not use weblib yet in installer.

Parameters

stdClass	$config
string	$stagename
string	$heading
string	$stagetext
string	$stageclass

Return values

void

◆ install_print_help_page()

object install_print_help_page ( $help )

Prints complete help page used during installation.

Does not return.

Parameters

string $help

◆ instance()

static filter_manager::instance ( )

static

Factory method.

Use this to get the filter manager.

Return values

filter_manager the singleton instance.

◆ instance_is_visible()

object instance_is_visible	(		$moduletype,
			$module )

Determine whether a module instance is visible within a course.

Given a valid module object with info about the id and course, and the module's type (eg "forum") returns whether the object is visible or not according to the 'eye' icon only.

NOTE: This does NOT take into account visibility to a particular user. To get visibility access for a specific user, use get_fast_modinfo, get a cm_info object from this, and check the ->uservisible property; or use the core_availability\info_module\is_user_visible() static function.

Parameters

$moduletype	Name of the module eg 'forum'
$module	Object which is the instance of the module

Return values

bool Success

◆ invalidate_opcode_php_cache()

static invalidate_opcode_php_cache ( $file )

static

Invalidate opcode cache for given file, this is intended for php files that are stored in dataroot.

Note: we need it here because this class must be self-contained.

Parameters

string $file

◆ ip_is_public()

ip_is_public ( $ip )

Is IP address a public address?

Parameters

string $ip The ip to check

Return values

bool	true if the ip is public

◆ iplookup_find_location()

iplookup_find_location ( $ip )

Returns location information.

Parameters

string $ip

Return values

array

◆ is_core_api()

static is_core_api ( $apiname )

static

Return true if apiname is a core API.

Parameters

string $apiname name of the API.

Return values

bool	true if core API.

◆ is_core_subsystem()

static is_core_subsystem ( $subsystemname )

static

Return true if subsystemname is core subsystem.

Parameters

string $subsystemname name of the subsystem.

Return values

bool	true if core subsystem.

◆ is_course_participant()

is_course_participant ( )

Deprecated: use is_enrolled($context, $userid) instead.

◆ is_dataroot_insecure()

is_dataroot_insecure ( $fetchtest = false )

Try to verify that dataroot is not accessible from web.

Try to verify that dataroot is not accessible from web. It is not 100% correct but might help to reduce number of vulnerable sites. Protection from httpd.conf and .htaccess is not detected properly.

@uses INSECURE_DATAROOT_WARNING @uses INSECURE_DATAROOT_ERROR

Parameters

bool $fetchtest try to test public access by fetching file, default false

Return values

mixed empty means secure, INSECURE_DATAROOT_ERROR found a critical problem, INSECURE_DATAROOT_WARNING might be problematic

◆ is_early_init()

is_early_init ( $backtrace )

This function encapsulates the tests for whether an exception was thrown in early init – either during setup.php or during init of $OUTPUT.

If another exception is thrown then, and if we do not take special measures, we would just get a very cryptic message "Exception thrown without a stack frame in Unknown on line 0". That makes debugging very hard, so we do take special measures in default_exception_handler, with the help of this function.

Parameters

array $backtrace the stack trace to analyse.

Return values

boolean whether the stack trace is somewhere in output initialisation.

◆ is_enabled_auth()

is_enabled_auth ( $auth )

Checks if a given plugin is in the list of enabled authentication plugins.

Parameters

string $auth Authentication plugin.

Return values

boolean Whether the plugin is enabled.

◆ is_enrolled()

is_enrolled	(	context	$context,
			$user = null,
			$withcapability = '',
			$onlyactive = false )

Returns true if user is enrolled (is participating) in course this is intended for students and teachers.

Since 2.2 the result for active enrolments and current user are cached.

Parameters

context	$context
int \| stdClass	$user	if null $USER is used, otherwise user object or id expected
string	$withcapability	extra capability name
bool	$onlyactive	consider only active enrolments in enabled plugins and time restrictions

Return values

bool

◆ is_float_problem()

is_float_problem ( )

Detects if float supports at least 10 decimal digits.

Detects if float supports at least 10 decimal digits and also if float-->string conversion works as expected.

Return values

bool	true if problem found

◆ is_https()

is_https ( )

Determines whether or not the Moodle site is being served over HTTPS.

This is done simply by checking the value of $CFG->wwwroot, which seems to be the only reliable method.

Return values

boolean True if site is served over HTTPS, false otherwise.

◆ is_in_popup()

is_in_popup ( )

Returns true if the page is displayed in a popup window.

Gets the information from the URL parameter inpopup.

Todo: Use a central function to create the popup calls all over Moodle and In the moment only works with resources and probably questions.

Return values

boolean

◆ is_internal_auth()

is_internal_auth ( $auth )

Returns true if an internal authentication method is being used.

if method not specified then, global default is assumed

Parameters

string $auth Form of authentication required

Return values

bool

◆ is_latest()

is_latest	(	string	$version,
		string	$questionbankentryid )

Checks if question is the latest version.

Parameters

string	$version	Question version to check.
string	$questionbankentryid	Entry to check against.

Return values

bool

◆ is_major_upgrade_required()

is_major_upgrade_required ( )

Check whether a major upgrade is needed.

That is defined as an upgrade that changes something really fundamental in the database, so nothing can possibly work until the database has been updated, and that is defined by the hard-coded version number in this function.

Return values

bool

◆ is_mnet_remote_user()

is_mnet_remote_user ( $user )

Returns whether or not the user object is a remote MNET user.

This function is in moodlelib because it does not rely on loading any of the MNET code.

Parameters

object $user A valid user object

Return values

bool	True if the user is from a remote Moodle.

◆ is_moodle_cookie_secure()

is_moodle_cookie_secure ( )

Determine wether the secure flag should be set on cookies.

Return values

bool

◆ is_newnav()

is_newnav ( $navigation )

Check if the passed navigation is of the new style.

Parameters

mixed $navigation

Return values

bool	true for yes false for no

◆ is_number()

is_number ( $value )

Return true if given value is integer or string with integer value.

Parameters

mixed $value String or Int

Return values

bool	true if number, false if not

◆ is_primary_admin()

is_primary_admin ( $userid )

Is a userid the primary administrator?

Parameters

int $userid int id of user to check

Return values

boolean

◆ is_proxybypass()

is_proxybypass ( $url )

Check if $url matches anything in proxybypass list.

Any errors just result in the proxy being used (least bad)

Parameters

string $url url to check

Return values

boolean true if we should bypass the proxy

◆ is_restored_user()

is_restored_user ( $username )

Returns true if the user is a 'restored' one.

Used in the login process to inform the user and allow him/her to reset the password

Parameters

string $username username to be checked

Return values

bool

◆ is_rtl_compatible()

is_rtl_compatible ( $paramtype )

Whether the PARAM_* type is compatible in RTL.

Being compatible with RTL means that the data they contain can flow from right-to-left or left-to-right without compromising the user experience.

Take URLs for example, they are not RTL compatible as they should always flow from the left to the right. This also applies to numbers, email addresses, configuration snippets, base64 strings, etc...

This function tries to best guess which parameters can contain localised strings.

Parameters

string $paramtype Constant PARAM_*.

Return values

bool

◆ is_valid_plugin_name() [1/2]

is_valid_plugin_name ( $name )

This method validates a plug name.

It is much faster than calling clean_param.

Parameters

string $name a string that might be a plugin name.

Return values

bool	if this string is a valid plugin name.

◆ is_valid_plugin_name() [2/2]

static is_valid_plugin_name	(		$plugintype,
			$pluginname )

static

This method validates a plug name.

It is much faster than calling clean_param.

Parameters

string	$plugintype	type of plugin
string	$pluginname	a string that might be a plugin name.

Return values

bool	if this string is a valid plugin name.

◆ is_web_crawler()

is_web_crawler ( )

Deprecated: since Moodle 3.0 use core_useragent\is_web_crawler instead.

◆ ismoving()

ismoving ( $courseid )

Determines if the logged in user is currently moving an activity.

Parameters

int $courseid The id of the course being tested

Return values

bool

◆ js_minify()

js_minify ( )

Deprecated: since 2.6

◆ ldap_addslashes()

ldap_addslashes ( $text )

Quote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253.

Parameters

string the AttributeValue to quote

Return values

string the AttributeValue quoted

◆ ldap_connect_moodle()

ldap_connect_moodle	(		$host_url,
			$ldap_version,
			$user_type,
			$bind_dn,
			$bind_pw,
			$opt_deref,
		&	$debuginfo,
			$start_tls = false )

Tries connect to specified ldap servers.

Returns a valid LDAP connection or false.

Parameters

string	$host_url
integer	$ldap_version	either 2 (LDAPv2) or 3 (LDAPv3).
string	$user_type	the configured user type for this connection.
string	$bind_dn	the binding user dn. If an emtpy string, anonymous binding is used.
string	$bind_pw	the password for the binding user. Ignored for anonymous bindings.
boolean	$opt_deref	whether to set LDAP_OPT_DEREF on this connection or not.
string	&$debuginfo	the debugging information in case the connection fails.
boolean	$start_tls	whether to use LDAP with TLS (not to be confused with LDAP+SSL)

Return values

mixed connection result or false.

◆ ldap_filter_addslashes()

ldap_filter_addslashes ( $text )

Quote control characters in texts used in LDAP filters - see RFC 4515/2254.

Parameters

string filter string to quote

Return values

string the filter string quoted

◆ ldap_find_userdn()

ldap_find_userdn	(	$ldapconnection,
		$username,
		$contexts,
		$objectclass,
		$search_attrib,
		$search_sub )

Search specified contexts for username and return the user dn like: cn=username,ou=suborg,o=org.

Parameters

mixed	$ldapconnection	a valid LDAP connection.
mixed	$username	username (external LDAP encoding, no db slashes).
array	$contexts	contexts to look for the user.
string	$objectclass	objectlass of the user (in LDAP filter syntax).
string	$search_attrib	the attribute use to look for the user.
boolean	$search_sub	whether to search subcontexts or not.

Return values

mixed the user dn (external LDAP encoding, no db slashes) or false

◆ ldap_get_dn_special_chars()

if(!defined( 'LDAP_DN_SPECIAL_CHARS')) if(!defined('LDAP_DN_SPECIAL_CHARS_QUOTED_NUM')) if(!defined( 'LDAP_DN_SPECIAL_CHARS_QUOTED_ALPHA')) if(!defined('LDAP_DN_SPECIAL_CHARS_QUOTED_ALPHA_REGEX')) ldap_get_dn_special_chars ( )

The order of the special characters in these arrays IS IMPORTANT.

Make sure '::::5C' (and '\') are the first elements of the arrays. Otherwise we'll double replace '::' with '\5C' which is Bad(tm)

◆ ldap_get_entries_moodle()

ldap_get_entries_moodle	(		$ldapconnection,
			$searchresult )

Returns values like ldap_get_entries but is binary compatible and returns all attributes as array.

Parameters

mixed	$ldapconnection	A valid LDAP connection
mixed	$searchresult	A search result from ldap_search, ldap_list, etc.

Return values

array ldap-entries with lower-cased attributes as indexes

◆ ldap_getdefaults()

ldap_getdefaults ( )

Initializes needed variables for ldap-module.

Uses names defined in ldap_supported_usertypes. $default is first defined as: $default['pseudoname'] = array( 'typename1' => 'value', 'typename2' => 'value' .... );

Return values

array of default values

◆ ldap_isgroupmember()

ldap_isgroupmember	(	$ldapconnection,
		$userid,
		$group_dns,
		$member_attrib )

Checks if user belongs to specific group(s) or is in a subtree.

Returns true if user belongs to a group in grupdns string OR if the DN of the user is in a subtree of the DN provided as "group"

Parameters

mixed	$ldapconnection	A valid LDAP connection.
string	$userid	LDAP user id (dn/cn/uid/...) to test membership for.
array	$group_dns	arrary of group dn
string	$member_attrib	the name of the membership attribute.

Return values

boolean

◆ ldap_normalise_objectclass()

ldap_normalise_objectclass	(		$objectclass,
			$default = '*' )

Normalise the supplied objectclass filter.

This normalisation is a rudimentary attempt to format the objectclass filter correctly.

Parameters

string	$objectclass	The objectclass to normalise
string	$default	The default objectclass value to use if no objectclass was supplied

Return values

string The normalised objectclass.

◆ ldap_paged_results_supported()

ldap_paged_results_supported	(		$ldapversion,
			$ldapconnection = null )

Check if we can use paged results (see RFC 2696).

We need to use LDAP version 3 (or later), otherwise the server cannot use them. If we also pass in a valid LDAP connection handle, we also check whether the server actually supports them.

Parameters

ldapversion	integer The LDAP protocol version we use.
ldapconnection	resource An existing LDAP connection (optional).

Return values

boolean true is paged results can be used, false otherwise.

◆ ldap_stripslashes()

ldap_stripslashes ( $text )

Unquote control characters in AttributeValue parts of a RelativeDistinguishedName used in LDAP distinguished names - See RFC 4514/2253.

Parameters

string the AttributeValue quoted

Return values

string the AttributeValue unquoted

◆ ldap_supported_usertypes()

if(!defined('ROOTDSE')) if(!defined( 'LDAP_PAGED_RESULTS_CONTROL')) if(!defined('LDAP_DEFAULT_PAGESIZE')) ldap_supported_usertypes ( )

Returns predefined user types.

Return values

array of predefined user types

◆ link_arrow_left()

link_arrow_left	(	$text,
		$url = '',
		$accesshide = false,
		$addclass = '',
		$addparams = [] )

Return the left arrow with text ('previous'), and optionally embedded in a link.

Parameters

string	$text	HTML/plain text label (set to blank only for breadcrumb separator cases).
string	$url	An optional link to use in a surrounding HTML anchor.
bool	$accesshide	True if text should be hidden (for screen readers only).
string	$addclass	Additional class names for the link, or the arrow character.

Return values

string HTML string.

◆ link_arrow_right()

link_arrow_right	(	$text,
		$url = '',
		$accesshide = false,
		$addclass = '',
		$addparams = [] )

Return the right arrow with text ('next'), and optionally embedded in a link.

Parameters

string	$text	HTML/plain text label (set to blank only for breadcrumb separator cases).
string	$url	An optional link to use in a surrounding HTML anchor.
bool	$accesshide	True if text should be hidden (for screen readers only).
string	$addclass	Additional class names for the link, or the arrow character.

Return values

string HTML string.

◆ load_course_context()

load_course_context ( )

Deprecated: since Moodle 3.4 and removed immediately. MDL-49398.

◆ load_environment_xml()

load_environment_xml ( $env_select = ENV_SELECT_NEWER )

This function will load the environment.xml file and xmlize it.

@staticvar array $data @uses ENV_SELECT_NEWER @uses ENV_SELECT_DATAROOT @uses ENV_SELECT_RELEASE

Parameters

int | string $env_select one of ENV_SELECT_NEWER | ENV_SELECT_DATAROOT | ENV_SELECT_RELEASE decide xml to use. String means plugin name.

Return values

mixed the xmlized structure or false on error

◆ load_filters()

filter_manager::load_filters ( $context )

protected

Load all the filters required by this context.

Parameters

context $context the context.

◆ load_renamed_classes()

static load_renamed_classes ( ?string $fulldir )

staticprotected

Loads the db/renamedclasses.php file from the given directory.

The renamedclasses.php should contain a key => value array ($renamedclasses) where the key is old class name, and the value is the new class name. It is only included when we are populating the component cache. After that is not needed.

Parameters

string | null $fulldir The directory to the renamed classes.

◆ load_role_access_by_context()

load_role_access_by_context ( )

Deprecated: since Moodle 3.4 and removed immediately. MDL-49398.

◆ log()

core\task\log	(		$message,
			$depth = 1 )

protected

Log a message to the progress tracer.

Parameters

string	$message
int	$depth

◆ log_finish()

core\task\log_finish	(		$message,
			$depth = 0 )

protected

Log an end message to the progress tracer.

Parameters

string	$message
int	$depth

◆ log_start()

core\task\log_start	(		$message,
			$depth = 0 )

protected

Log a start message to the progress tracer.

Parameters

string	$message
int	$depth

◆ log_update_descriptions()

log_update_descriptions ( $component )

Log_display description function used during install and upgrade.

Parameters

string $component name of component (moodle, etc.)

Return values

void

◆ login_attempt_failed()

login_attempt_failed ( $user )

To be called after failed user login.

Parameters

stdClass $user

Exceptions

invalid_dataroot_permissions

◆ login_attempt_valid()

login_attempt_valid ( $user )

To be called after valid user login.

Parameters

stdClass $user

◆ login_is_lockedout()

login_is_lockedout ( $user )

Verify if user is locked out.

Parameters

stdClass $user

Return values

bool	true if user locked out

◆ login_lock_account()

login_lock_account ( $user )

Lockout user and send notification email.

Parameters

stdClass $user

◆ login_unlock_account()

login_unlock_account ( $user )

Unlock user account and reset timers.

Parameters

stdClass $user

◆ make_backup_temp_directory()

make_backup_temp_directory	(		$directory,
			$exceptiononerror = true )

Create a directory under $CFG->backuptempdir and make sure it is writable.

Do not use for storing generic temp files - see make_temp_directory() instead for this purpose.

Backup temporary files must be on a shared storage.

Parameters

string	$directory	the relative path of the directory to be created under $CFG->backuptempdir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false Returns full path to directory if successful, false if not; may throw exception

◆ make_cache_directory()

make_cache_directory	(		$directory,
			$exceptiononerror = true )

Create a directory under cachedir and make sure it is writable.

Note: this cache directory is shared by all cluster nodes.

Parameters

string	$directory	the full path of the directory to be created under $CFG->cachedir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false Returns full path to directory if successful, false if not; may throw exception

◆ make_categories_list()

make_categories_list ( )

Deprecated: since 2.5

◆ make_categories_options()

make_categories_options ( )

Deprecated: since Moodle 3.10

◆ make_editing_buttons()

make_editing_buttons ( )

Deprecated: since 2.5. Please use: $courserenderer = $PAGE->get_renderer('core', 'course'); $actions = course_get_cm_edit_actions($mod, $indent, $section); return ' ' . $courserenderer->course_section_cm_edit_actions($actions);

◆ make_filter_object() [1/2]

filter_manager::make_filter_object	(	$filtername,
		$context,
		$localconfig )

protected

Factory method for creating a filter.

Parameters

string	$filtername	The filter name, for example 'tex'.
context	$context	context object.
array	$localconfig	array of local configuration variables for this filter.

Return values

moodle_text_filter The filter, or null, if this type of filter is not recognised or could not be created.

Reimplemented in performance_measuring_filter_manager.

◆ make_filter_object() [2/2]

performance_measuring_filter_manager::make_filter_object	(	$filtername,
		$context,
		$localconfig )

protected

Factory method for creating a filter.

Parameters

string	$filtername	The filter name, for example 'tex'.
context	$context	context object.
array	$localconfig	array of local configuration variables for this filter.

Return values

moodle_text_filter The filter, or null, if this type of filter is not recognised or could not be created.

Reimplemented from filter_manager.

◆ make_grades_menu()

make_grades_menu ( $gradingtype )

Creates an array that represents all the current grades that can be chosen using the given grading type.

Negative numbers are scales, zero is no grade, and positive numbers are maximum grades.

Todo: Finish documenting this function or better deprecated this completely!

Parameters

int $gradingtype

Return values

array

◆ make_localcache_directory()

make_localcache_directory	(		$directory,
			$exceptiononerror = true )

Create a directory under localcachedir and make sure it is writable.

The files in this directory MUST NOT change, use revisions or content hashes to work around this limitation - this means you can only add new files here.

The content of this directory gets purged automatically on all cluster nodes after calling purge_all_caches() before new data is written to this directory.

Note: this local cache directory does not need to be shared by cluster nodes.

Parameters

string	$directory	the relative path of the directory to be created under $CFG->localcachedir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false Returns full path to directory if successful, false if not; may throw exception

◆ make_menu_from_list()

make_menu_from_list	(		$list,
			$separator = ',' )

Given a list (eg a,b,c,d,e) this function returns an array of 1->a, 2->b, 3->c etc.

Parameters

string	$list	The string to explode into array bits
string	$separator	The separator used within the list string

Return values

array The now assembled array

◆ make_request_directory()

make_request_directory	(	bool	$exceptiononerror = true,
		bool	$forcecreate = false )

Create a per-request directory and make sure it is writable.

This can only be used during the current request and will be tidied away automatically afterwards.

A new, unique directory is always created within a shared base request directory.

In some exceptional cases an alternative base directory may be required. This can be accomplished using the $forcecreate parameter. Typically this will only be requried where the file may be required during a shutdown handler which may or may not be registered after a previous request directory has been created.

Parameters

bool	$exceptiononerror	throw exception if error encountered
bool	$forcecreate	Force creation of a new parent directory

Return values

string The full path to directory if successful, false if not; may throw exception

◆ make_temp_directory()

make_temp_directory	(		$directory,
			$exceptiononerror = true )

Create a directory under tempdir and make sure it is writable.

Where possible, please use make_request_directory() and limit the scope of your data to the current HTTP request.

Do not use for storing cache files - see make_cache_directory(), and make_localcache_directory() instead for this purpose.

Temporary files must be on a shared storage, and heavy usage is discouraged due to the performance impact upon clustered environments.

Parameters

string	$directory	the full path of the directory to be created under $CFG->tempdir
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false Returns full path to directory if successful, false if not; may throw exception

◆ make_timestamp()

make_timestamp	(	$year,
		$month = 1,
		$day = 1,
		$hour = 0,
		$minute = 0,
		$second = 0,
		$timezone = 99,
		$applydst = true )

Given Gregorian date parts in user time produce a GMT timestamp.

Parameters

int	$year	The year part to create timestamp of
int	$month	The month part to create timestamp of
int	$day	The day part to create timestamp of
int	$hour	The hour part to create timestamp of
int	$minute	The minute part to create timestamp of
int	$second	The second part to create timestamp of
int \| float \| string	$timezone	Timezone modifier, used to calculate GMT time offset. if 99 then default user's timezone is used
bool	$applydst	Toggle Daylight Saving Time, default true, will be applied only if timezone is 99 or string.

Return values

int	GMT timestamp

◆ make_unique_id_code()

make_unique_id_code ( $extra = '' )

make_unique_id_code

Todo: Finish documenting this function

@uses $_SERVER

Parameters

string $extra Extra string to append to the end of the code

Return values

string

◆ make_unique_writable_directory()

make_unique_writable_directory	(		$basedir,
			$exceptiononerror = true )

Create a new unique directory within the specified directory.

Parameters

string	$basedir	The directory to create your new unique directory within.
bool	$exceptiononerror	throw exception if error encountered

Return values

string The created directory

Exceptions

◆ make_upload_directory()

make_upload_directory	(		$directory,
			$exceptiononerror = true )

Create a directory under dataroot and make sure it is writable.

Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().

Parameters

string	$directory	the full path of the directory to be created under $CFG->dataroot
bool	$exceptiononerror	throw exception if error encountered

Return values

string|false Returns full path to directory if successful, false if not; may throw exception

◆ mark_context_dirty()

mark_context_dirty ( )

Deprecated: since 2.2, use $context->mark_dirty() instead

◆ markdown_to_html()

markdown_to_html ( $text )

Given Markdown formatted text, make it into XHTML using external function.

Parameters

string $text The markdown formatted text to be converted.

Return values

string Converted text

◆ match_grade_options()

match_grade_options	(	$gradeoptionsfull,
		$grade,
		$matchgrades = 'error' )

Check whether a given grade is one of a list of allowed options.

If not, depending on $matchgrades, either return the nearest match, or return false to signal an error.

Parameters

array	$gradeoptionsfull	list of valid options
int	$grade	grade to be tested
string	$matchgrades	'error' or 'nearest'

Return values

false|int|string either 'fixed' value or false if error.

◆ matching_page_type_patterns()

matching_page_type_patterns ( $pagetype )

Given a specific page type, return all the page type patterns that might match it.

Parameters

string $pagetype for example 'course-view-weeks' or 'mod-quiz-view'.

Return values

array an array of all the page type patterns that might match this page type.

◆ matching_page_type_patterns_from_pattern()

matching_page_type_patterns_from_pattern ( $pattern )

Give an specific pattern, return all the page type patterns that would also match it.

Parameters

string $pattern the pattern, e.g. 'mod-forum-*' or 'mod-quiz-view'.

Return values

array of all the page type patterns matching.

◆ mb_internal_encoding()

Html2Text\mb_internal_encoding ( $encoding = null )

Set the encoding to be used by our monkey patched mb_ functions.

When called with $encoding !== null, we set the static $intenalencoding variable, which is used for subsequent calls.

When called with no value for $encoding, we return the previously defined $internalencoding.

This is necessary as we need to maintain the state of mb_internal_encoding across calls to other mb_* functions. Check how it is used in the other mb_* functions defined here - if no encoding is provided we fallback to what was set here, otherwise we used the given encoding.

@staticvar string $internalencoding The encoding to be used across mb_* calls.

Parameters

string $encoding When given, sets $internalencoding

Return values

mixed

◆ mb_strlen()

Html2Text\mb_strlen	(		$str,
			$encoding = null )

Gets the length of a string.

Parameters

string	$str	The string being checked for length.
string	$encoding	The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used.

Return values

int	The number of characters in str having character encoding $encoding. A multibyte character is counted as 1.

◆ mb_strtolower()

Html2Text\mb_strtolower	(		$str,
			$encoding = null )

Returns $str with all alphabetic chatacters converted to lowercase.

Parameters

string	$str	The string being lowercased.
string	$encoding	The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used.

Return values

string The string with all alphabetic characters converted to lowercase.

◆ mb_strtoupper()

Html2Text\mb_strtoupper	(		$str,
			$encoding = null )

Parameters

	string	The string being uppercased
string	$encoding	The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used.

Return values

string The string with all alphabetic characters converted to uppercase.

◆ mb_substr()

Html2Text\mb_substr	(	$str,
		$start,
		$length = null,
		$encoding = null )

Performs a multi-byte safe substr() operation based on number of characters.

Position is counted from the beginning of str. First character's position is 0. Second character position is 1, and so on.

Parameters

string	$str	The string to extract the substring from.
int	$start	If start is non-negative, the returned string will start at the start'th position in string, counting from zero. For instance, in the string 'abcdef', the character at position 0 is 'a', the character at position 2 is 'c', and so forth.
int	$length	Maximum number of characters to use from str. If omitted or NULL is passed, extract all characters to the end of the string.
string	$encoding	The encoding parameter is the character encoding. If it is omitted, the internal character encoding value will be used.

Return values

string The portion of str specified by the start and length parameters.

◆ mdie()

mdie	(		$msg = '',
			$errorcode = 1 )

Print an error to STDOUT and exit with a non-zero code.

For commandline scripts.

Default errorcode is 1.

Very useful for perl-like error-handling: do_somethting() or mdie("Something went wrong");

Parameters

string	$msg	Error message
integer	$errorcode	Error code to emit

◆ me()

me ( )

Returns the name of the current script, WITH the querystring portion.

This function is necessary because PHP_SELF and REQUEST_URI and SCRIPT_NAME return different things depending on a lot of things like your OS, Web server, and the way PHP is compiled (ie. as a CGI, module, ISAPI, etc.) NOTE: This function returns false if the global variables needed are not set.

Return values

mixed String or false if the global variables needed are not set.

◆ merge_query_params()

merge_query_params	(	array &	$target,
		array	$values )

Merge parsed POST chunks.

NOTE: this is not perfect, but it should work in most cases hopefully.

Parameters

array	$target
array	$values

◆ message_add_contact()

message_add_contact ( )

Deprecated: since Moodle 3.6

◆ message_block_contact()

message_block_contact ( )

Deprecated: since Moodle 3.6

◆ message_can_delete_message()

message_can_delete_message ( )

Deprecated: since Moodle 3.5

◆ message_can_post_message()

message_can_post_message ( )

Deprecated: since Moodle 3.2

◆ message_contact_link()

message_contact_link ( )

Deprecated: since Moodle 3.2

◆ message_count_blocked_users()

message_count_blocked_users ( )

Deprecated: since Moodle 3.2

◆ message_count_messages()

message_count_messages ( )

Deprecated: since Moodle 3.2

◆ message_count_unread_messages()

message_count_unread_messages ( )

Deprecated: since 3.10

◆ message_current_user_is_involved()

message_current_user_is_involved ( )

Deprecated: since Moodle 2.9 MDL-49371 - please do not use this function any more.

◆ message_delete_message()

message_delete_message ( )

Deprecated: since Moodle 3.5

◆ message_get_blocked_users()

message_get_blocked_users ( )

Deprecated: since Moodle 3.5

◆ message_get_contact()

message_get_contact ( )

Deprecated: since Moodle 3.6

◆ message_get_contact_add_remove_link()

message_get_contact_add_remove_link ( )

Deprecated: since Moodle 3.2

◆ message_get_contact_block_link()

message_get_contact_block_link ( )

Deprecated: since Moodle 3.2

◆ message_get_contacts()

message_get_contacts ( )

Deprecated: since Moodle 3.5

◆ message_get_course_contexts()

message_get_course_contexts ( )

Deprecated: since Moodle 3.2

◆ message_get_fragment()

message_get_fragment ( )

Deprecated: since Moodle 3.2

◆ message_get_history()

message_get_history ( )

Deprecated: since Moodle 3.2

◆ message_get_recent_conversations()

message_get_recent_conversations	(	$userorid,
		$limitfrom = 0,
		$limitto = 100 )

Deprecated: since Moodle 3.3 MDL-57370

◆ message_get_recent_notifications()

message_get_recent_notifications ( )

Deprecated: since Moodle 3.2

◆ message_history_link()

message_history_link ( )

Deprecated: since Moodle 3.2

◆ message_is_user_blocked()

message_is_user_blocked ( )

Deprecated: since Moodle 3.2

◆ message_is_user_non_contact_blocked()

message_is_user_non_contact_blocked ( )

Deprecated: since Moodle 3.2

◆ message_mark_message_read()

message_mark_message_read ( )

Deprecated: since Moodle 3.5

◆ message_mark_messages_read()

message_mark_messages_read ( )

Deprecated: since Moodle 3.2

◆ message_move_userfrom_unread2read()

message_move_userfrom_unread2read ( )

Deprecated: since Moodle 3.5

◆ message_remove_contact()

message_remove_contact ( )

Deprecated: since Moodle 3.6

◆ message_remove_url_params()

message_remove_url_params ( )

Deprecated: since Moodle 3.2

◆ message_search()

message_search ( )

Deprecated: since Moodle 3.2

◆ message_shorten_message()

message_shorten_message ( )

Deprecated: since Moodle 3.2

◆ message_unblock_contact()

message_unblock_contact ( )

Deprecated: since Moodle 3.6

◆ microtime_diff()

microtime_diff	(		$a,
			$b )

Calculate the difference between two microtimes.

Parameters

string	$a	The first Microtime
string	$b	The second Microtime

Return values

string

◆ min_clean_param()

min_clean_param	(		$value,
			$type )

Minimalistic parameter cleaning function.

Note: Can not use optional param because moodlelib.php is not loaded yet.

Parameters

string	$value
string	$type

Return values

mixed

◆ min_enable_zlib_compression()

min_enable_zlib_compression ( )

This method tries to enable output compression if possible.

This function must be called before any output or headers.

(IE6 is not supported at all.)

Return values

boolean,true if compression enabled

◆ min_fix_utf8()

min_fix_utf8 ( $value )

Minimalistic UTF-8 sanitisation.

Note: This duplicates fix_utf8() intentionally for now.

Parameters

string $value

Return values

string

◆ min_get_maximum_revision()

min_get_maximum_revision ( )

Get the highest possible currently valid revision number.

This is based on the current time, allowing for a small amount of clock skew between servers.

Future values beyond the clock skew are not allowed to avoid the possibility of cache poisoning.

Return values

int

◆ min_get_minimum_revision()

min_get_minimum_revision ( )

Get the lowest possible currently valid revision number.

This is based on the current Moodle version.

Return values

int	Unix timestamp

◆ min_get_slash_argument()

min_get_slash_argument ( $clean = true )

Returns the slashargument part of the URL.

Note: ".php" is NOT allowed in slasharguments, it is intended for ASCII characters only.

Parameters

boolean $clean - Should we do cleaning on this path argument. If you set this to false you MUST be very careful and do the cleaning manually.

Return values

string

◆ min_is_revision_valid_and_current()

min_is_revision_valid_and_current ( int $revision )

Helper function to determine if the given revision number is valid.

Parameters

int $revision A numeric revision to check for validity

Return values

bool	Whether the revision is valid

◆ min_optional_param()

min_optional_param	(	$name,
		$default,
		$type )

Minimalistic parameter validation function.

Can not use optional param because moodlelib.php is not loaded yet

Parameters

string	$name
mixed	$default
string	$type

Return values

mixed

◆ mnet_get_idp_jump_url()

mnet_get_idp_jump_url ( $user )

return the jump url for a given remote user this is used for rewriting forum post links in emails, etc

Parameters

stdclass $user the user to get the idp url for

◆ mod_page_type_list()

mod_page_type_list	(	$pagetype,
		$parentcontext = null,
		$currentcontext = null )

Generates the page type list for a module by either locating and using the modules callback or by generating a default list.

Parameters

string	$pagetype
stdClass	$parentcontext
stdClass	$currentcontext

Return values

array

◆ moodle_getlocale()

moodle_getlocale ( )

Gets the system locale.

Return values

string Retuns the current locale.

◆ moodle_major_version()

moodle_major_version ( $fromdisk = false )

Returns the major version of this site.

Moodle version numbers consist of three numbers separated by a dot, for example 1.9.11 or 2.0.2. The first two numbers, like 1.9 or 2.0, represent so called major version. This function extracts the major version from either $CFG->release (default) or eventually from the $release variable defined in the main version.php.

Parameters

bool $fromdisk should the version if source code files be used

Return values

string|false the major version like '2.3', false if could not be determined

◆ moodle_minimum_php_version_is_met()

moodle_minimum_php_version_is_met ( $haltexecution = false )

Tests the current PHP version against Moodle's minimum requirement.

When requirement is not met returns false or halts execution depending $haltexecution param.

Parameters

bool $haltexecution Should execution be halted when requirement not met? Defaults to false.

Return values

bool	returns true if requirement is met (false if not)

◆ moodle_needs_upgrading()

moodle_needs_upgrading ( $checkupgradeflag = true )

Determine if moodle installation requires update.

Checks version numbers of main code and all plugins to see if there are any mismatches.

Parameters

bool $checkupgradeflag check the outagelessupgrade flag to see if an upgrade is running.

Return values

bool

◆ moodle_process_email()

moodle_process_email	(		$modargs,
			$body )

?

Todo: Finish documenting this function

Parameters

string	$modargs
string	$body	Currently unused

◆ moodle_require_minimum_php_version()

moodle_require_minimum_php_version ( )

Require our minimum php version or halt execution if requirement not met.

Return values

void	Execution is halted if version is not met.

◆ moodle_setlocale()

moodle_setlocale ( $locale = '' )

Sets the system locale.

Parameters

string $locale Can be used to force a locale

◆ move_category()

move_category ( )

Deprecated: since 2.5

◆ move_question_set_references()

move_question_set_references	(	int	$oldcategoryid,
		int	$newcatgoryid,
		int	$oldcontextid,
		int	$newcontextid,
		bool	$delete = false )

Update the questioncontextid field for all question_set_references records given a new context id.

Parameters

int	$oldcategoryid	Old category to be moved.
int	$newcatgoryid	New category that will receive the questions.
int	$oldcontextid	Old context to be moved.
int	$newcontextid	New context that will receive the questions.
bool	$delete	If the action is delete.

Exceptions

◆ mtrace()

mtrace	(	$string,
		$eol = "\n",
		$sleep = 0 )

For outputting debugging info.

Parameters

string	$string	The string to write
string	$eol	The end of line char(s) to use
string	$sleep	Period to make the application sleep This ensures any messages have time to display before redirect

◆ mtrace_exception()

mtrace_exception ( Throwable $e )

Helper to {.

See also: mtrace()} an exception or throwable, including all relevant information.

Parameters

Throwable $e the error to ouptput.

◆ my_page_type_list()

my_page_type_list	(	$pagetype,
		$parentcontext = null,
		$currentcontext = null )

Generates the page type list for the my moodle page.

Parameters

string	$pagetype
stdClass	$parentcontext
stdClass	$currentcontext

Return values

array

◆ mygroupid()

mygroupid ( )

Deprecated: use groups_get_all_groups() instead.

◆ navmenu()

navmenu ( )

Deprecated: not relevant with global navigation in Moodle 2.x+

◆ navmenulist()

navmenulist	(	$course,
		$sections,
		$modinfo,
		$strsection,
		$strjumpto,
		$width = 50,
		$cmid = 0 )

Returns a popup menu with course activity modules.

Given a course this function returns a small popup menu with all the course activity modules in it, as a navigation menu outputs a simple list structure in XHTML. The data is taken from the serialised array stored in the course record.

Parameters

stdClass	$course	A course object.
array	$sections
course_modinfo	$modinfo
string	$strsection
string	$strjumpto
int	$width
string	$cmid

Return values

string The HTML block

◆ normalize_component()

normalize_component ( $component )

static

Normalize the component name using the "frankenstyle" rules.

Normalize the component name using the "frankenstyle" names.

Note: this does not verify the validity of plugin or type names.

Parameters

string $component

Return values

array two-items list of [(string)type, (string|null)name]

Deprecated: since 2.6, use core_component\normalize_component()

Parameters

string $component

Return values

array two-items list of [(string)type, (string|null)name]

◆ normalize_componentname()

static normalize_componentname ( $componentname )

static

Normalize the component name.

Note: this does not verify the validity of the plugin or component.

Parameters

string $component

Return values

string

◆ normalize_version()

normalize_version ( $version )

This function will normalize any version to just a serie of numbers separated by dots.

Everything else will be removed.

Parameters

string $version the original version

Return values

string the normalized version

◆ notice()

notice	(	$message,
		$link = '',
		$course = null )

Print a message and exit.

Parameters

string	$message	The message to print in the notice
moodle_url \| string	$link	The link to use for the continue button
object	$course	A course object. Unused.

Return values

void	This function simply exits

◆ notify()

notify ( )

Deprecated: since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.

◆ obfuscate_email()

obfuscate_email ( $email )

Given an email address, this function will return an obfuscated version of it.

Parameters

string $email The email address to obfuscate

Return values

string The obfuscated email address

◆ obfuscate_mailto()

obfuscate_mailto	(	$email,
		$label = '',
		$dimmed = false,
		$subject = '',
		$body = '' )

This function uses the obfuscate_email() and obfuscate_text() to generate a fully obfuscated email link, ready to use.

Parameters

string	$email	The email address to display
string	$label	The text to displayed as hyperlink to $email
boolean	$dimmed	If true then use css class 'dimmed' for hyperlink
string	$subject	The subject of the email in the mailto link
string	$body	The content of the email in the mailto link

Return values

string The obfuscated mailto link

◆ obfuscate_text()

obfuscate_text ( $plaintext )

This function takes some text and replaces about half of the characters with HTML entity equivalents.

Return string is obviously longer.

Parameters

string $plaintext The text to be obfuscated

Return values

string The obfuscated text

◆ object_array_unique()

object_array_unique	(		$array,
			$keepkeyassoc = true )

Returns an array without repeated objects.

This function is similar to array_unique, but for arrays that have objects as values

Parameters

array	$array
bool	$keepkeyassoc

Return values

array

◆ object_property_exists()

object_property_exists	(		$obj,
			$property )

Detect if an object or a class contains a given property will take an actual object or the name of a class.

Parameters

mixed	$obj	Name of class or real object to test
string	$property	name of property to find

Return values

bool	true if property exists

◆ optional_param()

optional_param	(	$parname,
		$default,
		$type )

Returns a particular value for the named variable, taken from POST or GET, otherwise returning a given default.

This function should be used to initialise all optional values in a script that are based on parameters. Usually it will be used like this: $name = optional_param('name', 'Fred', PARAM_TEXT);

Please note the $type parameter is now required and the value can not be array.

Parameters

string	$parname	the name of the page parameter we want
mixed	$default	the default value to return if nothing is found
string	$type	expected type of parameter

Return values

mixed

Exceptions

◆ optional_param_array()

optional_param_array	(	$parname,
		$default,
		$type )

Returns a particular array value for the named variable, taken from POST or GET, otherwise returning a given default.

This function should be used to initialise all optional values in a script that are based on parameters. Usually it will be used like this: $ids = optional_param('id', array(), PARAM_INT);

Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported

Parameters

string	$parname	the name of the page parameter we want
mixed	$default	the default value to return if nothing is found
string	$type	expected type of parameter

Return values

array

Exceptions

◆ order_in_string()

order_in_string	(		$values,
			$stringformat )

Returns an array of values in order of occurance in a provided string.

The key in the result is the character postion in the string.

Parameters

array	$values	Values to be found in the string format
string	$stringformat	The string which may contain values being searched for.

Return values

array An array of values in order according to placement in the string format.

◆ over_bounce_threshold()

over_bounce_threshold ( $user )

Check whether the user has exceeded the bounce threshold.

Parameters

stdClass $user A $USER object

Return values

bool	true => User has exceeded bounce threshold

◆ p()

p ( $var )

Add quotes to HTML characters.

Prints $var with HTML characters (like "<", ">", etc.) properly quoted. This function simply calls & displays s().

See also: s()

Parameters

string $var the string potentially containing HTML characters

◆ page_doc_link()

page_doc_link ( $text = '' )

Returns a string containing a link to the user documentation for the current page.

Also contains an icon by default. Shown to teachers and admin only.

Parameters

string $text The text to be displayed for the link

Return values

string The link to user documentation for this current page

◆ page_get_doc_link_path()

page_get_doc_link_path ( moodle_page $page )

Returns the path to use when constructing a link to the docs.

Since: Moodle 2.5.1 2.6

Parameters

moodle_page $page

Return values

string

◆ partial()

partial ( )

Helper function to do partial function binding.

so we can use it for preg_replace_callback, for example this works with php functions, user functions, static methods and class methods it returns you a callback that you can pass on like so:

$callback = partial('somefunction', $arg1, $arg2); or $callback = partial(array('someclass', 'somestaticmethod'), $arg1, $arg2); or even $obj = new someclass(); $callback = partial(array($obj, 'somemethod'), $arg1, $arg2);

and then the arguments that are passed through at calltime are appended to the argument list.

Parameters

mixed	$function	a php callback
mixed	$arg1,...	$argv arguments to partially bind with

Return values

array Array callback

◆ password_compat_not_supported()

password_compat_not_supported ( )

Deprecated: since 2.7 PHP 5.4.x should be always compatible.

◆ password_is_legacy_hash()

password_is_legacy_hash ( $password )

Check a password hash to see if it was hashed using the legacy hash algorithm (md5).

Parameters

string $password String to check.

Return values

boolean True if the $password matches the format of an md5 sum.

◆ perf_get_reads_slave()

perf_get_reads_slave ( )

Returns the number of reads done by the read only database.

Return values

int	Number of reads.

◆ phpunit_bootstrap_error()

phpunit_bootstrap_error	(		$errorcode,
			$text = '' )

Print error and stop execution.

Parameters

int	$errorcode	The exit error code
string	$text	An error message to display

Return values

void	stops code execution with error code

◆ plagiarism_get_file_results()

plagiarism_get_file_results	(	$cmid,
		$userid,
		$file )

returns array of plagiarism details about specified file

Deprecated: Since Moodle 4.0. - this function was a placeholder and not used in core.

Todo: MDL-71326 This is to be moved from here to deprecatedlib.php in Moodle 4.4

Parameters

int	$cmid
int	$userid
object	$file	moodle file object

Return values

array

- sets of details about specified file, one array of details per plagiarism plugin

each set contains at least 'analyzed', 'score', 'reporturl'

◆ plagiarism_get_form_elements_module()

plagiarism_get_form_elements_module ( )

Deprecated: Since Moodle 3.9. MDL-65835

◆ plagiarism_get_links()

if(!defined('MOODLE_INTERNAL')) plagiarism_get_links ( $linkarray )

displays the similarity score and provides a link to the full report if allowed.

Parameters

object $linkarray contains all relevant information for the plugin to generate a link

Return values

string - url to allow login/viewing of a similarity report

◆ plagiarism_load_available_plugins()

plagiarism_load_available_plugins ( )

Helper function - also loads lib file of plagiarism plugin.

Return values

array of available plugins

◆ plagiarism_print_disclosure()

plagiarism_print_disclosure ( $cmid )

Function that prints the student disclosure notifying that the files will be checked for plagiarism.

Parameters

integer $cmid - the cmid of this module

Return values

string

◆ plagiarism_save_form_elements()

plagiarism_save_form_elements ( )

Deprecated: Since Moodle 3.9. MDL-65835

◆ plagiarism_update_status()

plagiarism_update_status	(		$course,
			$cm )

Allows a plagiarism plugin to print a button/link at the top of activity overview report pages.

Deprecated: Since Moodle 4.0 - Please use {plugin name}_before_standard_top_of_body_html instead.

Todo: MDL-71326 Remove this method.

Parameters

object	$course	- full Course object
object	$cm	- full cm object

Return values

string

◆ plugin_callback()

plugin_callback	(	$type,
		$name,
		$feature,
		$action,
		$params = null,
		$default = null )

Invoke plugin's callback functions.

Parameters

string	$type	plugin type e.g. 'mod'
string	$name	plugin name
string	$feature	feature name
string	$action	feature's action
array	$params	parameters of callback function, should be an array
mixed	$default	default value if callback function hasn't been defined, or if it retursn null.

Return values

mixed

Todo: Decide about to deprecate and drop plugin_callback() - MDL-30743

◆ plugin_supports()

plugin_supports	(	$type,
		$name,
		$feature,
		$default = null )

Checks whether a plugin supports a specified feature.

Parameters

string	$type	Plugin type e.g. 'mod'
string	$name	Plugin name e.g. 'forum'
string	$feature	Feature code (FEATURE_xx constant)
mixed	$default	default value if feature support unknown

Return values

mixed Feature result (false if not supported, null if feature is unknown, otherwise usually true but may have other feature-specific value such as array)

Exceptions

◆ preload_course_contexts()

preload_course_contexts ( )

Deprecated: since Moodle 2.2

◆ prevent_form_autofill_password()

prevent_form_autofill_password ( )

Deprecated: since Moodle 3.2

◆ print_arrow()

object print_arrow	(	$direction = 'up',
		$strsort = null,
		$return = false )

Returns an image of an up or down arrow, used for column sorting.

To avoid unnecessary DB accesses, please provide this function with the language strings for sortasc and sortdesc.

Deprecated: use $OUTPUT->arrow() instead.

Todo: final deprecation of this function once MDL-45448 is resolved

If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.

Parameters

string	$direction	'up' or 'down'
string	$strsort	The language string used for the alt attribute of this image
bool	$return	Whether to print directly or return the html string

Return values

string|void depending on $return

◆ print_badge_image()

print_badge_image	(	badge	$badge,
		stdClass	$context,
			$size = 'small' )

Print badge image.

Parameters

badge	$badge	Badge object
stdClass	$context
string	$size

◆ print_category_info()

print_category_info ( )

Deprecated: since 2.5

◆ print_checkbox()

print_checkbox ( )

Deprecated: use html_writer\checkbox() instead.

◆ print_collapsible_region()

print_collapsible_region	(	$contents,
		$classes,
		$id,
		$caption,
		$userpref = '',
		$default = false,
		$return = false )

Print (or return) a collapsible region, that has a caption that can be clicked to expand or collapse the region.

If JavaScript is off, then the region will always be expanded.

Parameters

string	$contents	the contents of the box.
string	$classes	class names added to the div that is output.
string	$id	id added to the div that is output. Must not be blank.
string	$caption	text displayed at the top. Clicking on this will cause the region to expand or contract.
string	$userpref	the name of the user preference that stores the user's preferred default state. (May be blank if you do not wish the state to be persisted.
boolean	$default	Initial collapsed state to use if the user_preference it not set.
boolean	$return	if true, return the HTML as a string, rather than printing it.

Return values

string|void If $return is false, returns nothing, otherwise returns a string of HTML.

◆ print_collapsible_region_end()

print_collapsible_region_end ( $return = false )

Close a region started with print_collapsible_region_start.

Parameters

boolean $return if true, return the HTML as a string, rather than printing it.

Return values

string|void if $return is false, returns nothing, otherwise returns a string of HTML.

◆ print_collapsible_region_start()

print_collapsible_region_start	(	$classes,
		$id,
		$caption,
		$userpref = '',
		$default = false,
		$return = false,
		$extracontent = null )

Print (or return) the start of a collapsible region.

The collapsibleregion has a caption that can be clicked to expand or collapse the region. If JavaScript is off, then the region will always be expanded.

Parameters

string	$classes	class names added to the div that is output.
string	$id	id added to the div that is output. Must not be blank.
string	$caption	text displayed at the top. Clicking on this will cause the region to expand or contract.
string	$userpref	the name of the user preference that stores the user's preferred default state. (May be blank if you do not wish the state to be persisted.
boolean	$default	Initial collapsed state to use if the user_preference it not set.
boolean	$return	if true, return the HTML as a string, rather than printing it.
string	$extracontent	the extra content will show next to caption, eg.Help icon.

Return values

string|void if $return is false, returns nothing, otherwise returns a string of HTML.

◆ print_container()

print_container ( )

Deprecated: use $OUTPUT->container() instead.

◆ print_container_end()

print_container_end ( )

Deprecated: use $OUTPUT->container_end() instead.

◆ print_container_start()

print_container_start ( )

Deprecated: use $OUTPUT->container_start() instead.

◆ print_context_name()

print_context_name ( )

Deprecated: since 2.2

◆ print_continue()

print_continue ( )

Deprecated: use $OUTPUT->continue_button() instead.

◆ print_course()

print_course ( )

Deprecated: since 2.5

◆ print_course_search()

print_course_search ( )

Deprecated: since 2.5

◆ print_courses()

print_courses ( )

Deprecated: since 2.5

◆ print_error()

print_error	(	$errorcode,
		$module = 'error',
		$link = '',
		$a = null,
		$debuginfo = null )

Abort execution by throwing of a general exception, default exception handler displays the error message in most cases.

Deprecated: since Moodle 4.1

Todo: MDL-74484 Final deprecation in Moodle 4.5.

Parameters

string	$errorcode	The name of the language string containing the error message. Normally this should be in the error.php lang file.
string	$module	The language file to get the error message from.
string	$link	The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
object	$a	Extra words and phrases that might be required in the error string
string	$debuginfo	optional debugging information

Return values

void,always throws exception!

◆ print_grade_menu()

print_grade_menu	(	$courseid,
		$name,
		$current,
		$includenograde = true,
		$return = false )

Prints a grade menu (as part of an existing form) with help showing all possible numerical grades and scales.

Todo

Finish documenting this function

Deprecate: this is only used in a few contrib modules

Parameters

int	$courseid	The course ID
string	$name
string	$current
boolean	$includenograde	Include those with no grades
boolean	$return	If set to true returns rather than echo's

Return values

string|bool Depending on value of $return

◆ print_grade_plugin_selector()

print_grade_plugin_selector	(	$plugin_info,
		$active_type,
		$active_plugin,
		$return = false )

Print grading plugin selection popup form.

Deprecated: since Moodle 4.0. Dropdown box navigation has been replaced with tertiary navigation.

Parameters

array	$plugin_info	An array of plugins containing information for the selector
boolean	$return	return as string

Return values

nothing or string if $return true

◆ print_group_picture()

print_group_picture	(	$group,
		$courseid,
		$large = false,
		$return = false,
		$link = true,
		$includetoken = false )

Print a specified group's avatar.

Parameters

array \| stdClass	$group	A single group object OR array of groups.
int	$courseid	The course ID.
boolean	$large	Default small picture, or large.
boolean	$return	If false print picture, otherwise return the output as string
boolean	$link	Enclose image in a link to view specified course?
boolean	$includetoken	Whether to use a user token when displaying this group image. True indicates to generate a token for current user, and integer value indicates to generate a token for the user whose id is the value indicated. If the group picture is included in an e-mail or some other location where the audience is a specific user who will not be logged in when viewing, then we use a token to authenticate the user.

Return values

string|void Depending on the setting of $return

◆ print_header()

print_header ( )

Deprecated: use $PAGE methods instead.

◆ print_header_simple()

print_header_simple ( )

Deprecated: use $PAGE methods instead.

◆ print_location_comment()

print_location_comment	(	$file,
		$line,
		$return = false )

Outputs a HTML comment to the browser.

This is used for those hard-to-debug pages that use bits from many different files in very confusing ways (e.g. blocks).

print_location_comment(FILE, LINE);

Parameters

string	$file
integer	$line
boolean	$return	Whether to return or print the comment

Return values

string|void Void unless true given as third parameter

◆ print_log()

print_log ( )

Deprecated: since Moodle 3.2

◆ print_log_csv()

print_log_csv ( )

Deprecated: since Moodle 3.2

◆ print_log_ods()

print_log_ods ( )

Deprecated: since Moodle 3.2

◆ print_log_xls()

print_log_xls ( )

Deprecated: since Moodle 3.2

◆ print_mnet_log()

print_mnet_log ( )

Deprecated: since Moodle 3.2

◆ print_my_moodle()

print_my_moodle ( )

Deprecated: since 2.5

◆ print_navigation()

print_navigation ( )

Deprecated: use $OUTPUT->navbar() instead

◆ print_object()

print_object ( $object )

GENERAL HELPFUL THINGS ///////////////////////////////////.

Dumps a given object's information for debugging purposes

When used in a CLI script, the object's information is written to the standard error output stream. When used in a web script, the object is dumped to a pre-formatted block with the "notifytiny" CSS class.

Parameters

mixed $object The data to be printed

Return values

void	output is echo'd

◆ print_overview()

print_overview ( )

Deprecated: since 2.5

◆ print_password_policy()

print_password_policy ( )

Returns a localized sentence in the current language summarizing the current password policy.

Todo: this should be handled by a function/method in the language pack library once we have a support for it @uses $CFG

Return values

string

◆ print_question_icon()

print_question_icon ( $question )

Print the icon for the question type.

Parameters

object $question The question object for which the icon is required. Only $question->qtype is used.

Return values

string the HTML for the img tag.

◆ print_recent_activity()

print_recent_activity ( )

Deprecated: since 2.5

◆ print_recent_activity_note()

print_recent_activity_note	(	$time,
		$user,
		$text,
		$link,
		$return = false,
		$viewfullnames = null )

Display a recent activity note.

@staticvar string $strftimerecent

Parameters

int	$time	A timestamp int.
stdClass	$user	A user object from the database.
string	$text	Text for display for the note
string	$link	The link to wrap around the text
bool	$return	If set to true the HTML is returned rather than echo'd
string	$viewfullnames

Return values

string If $retrun was true returns HTML for a recent activity notice.

◆ print_remote_course()

print_remote_course ( )

Deprecated: since 2.5

◆ print_remote_host()

print_remote_host ( )

Deprecated: since 2.5

◆ print_scale_menu_helpbutton()

print_scale_menu_helpbutton ( )

Deprecated: use $OUTPUT->help_icon_scale($courseid, $scale) instead.

◆ print_section()

print_section ( )

Deprecated: since 2.5

◆ print_section_add_menus()

print_section_add_menus ( )

Deprecated: since 2.5

◆ print_side_block()

print_side_block ( )

Deprecated: use $OUTPUT->block() instead.

◆ print_string()

print_string	(	$identifier,
		$component = '',
		$a = null )

Prints out a translated string.

Prints out a translated string using the return value from the get_string() function.

Example usage of this function when the string is in the moodle.php file:
echo ''; print_string('course'); echo '';

Example usage of this function when the string is not in the moodle.php file:
echo '

`'; print_string('typecourse', 'calendar'); echo '`

';

Parameters

string	$identifier	The key identifier for the localized string
string	$component	The module where the key identifier is stored. If none is specified then moodle.php is used.
string \| object \| array	$a	An object, string or number that can be used within translation strings

◆ print_tabs()

print_tabs	(	$tabrows,
		$selected = null,
		$inactive = null,
		$activated = null,
		$return = false )

Returns a string containing a nested list, suitable for formatting into tabs with CSS.

It is not recommended to use this function in Moodle 2.5 but it is left for backward compartibility.

Example how to print a single line tabs: $rows = array( new tabobject(...), new tabobject(...) ); echo $OUTPUT->tabtree($rows, $selectedid);

Multiple row tabs may not look good on some devices but if you want to use them you can specify ->subtree for the active tabobject.

Parameters

array	$tabrows	An array of rows where each row is an array of tab objects
string	$selected	The id of the selected tab (whatever row it's on)
array	$inactive	An array of ids of inactive tabs that are not selectable.
array	$activated	An array of ids of other tabs that are currently activated
bool	$return	If true output is returned rather then echo'd

Return values

string HTML output if $return was set to true.

◆ print_textarea()

print_textarea ( )

Deprecated: since Moodle 3.6

◆ print_upgrade_part_end()

print_upgrade_part_end	(	$plugin,
		$installation,
		$verbose )

Default end upgrade callback.

Parameters

string	$plugin
bool	$installation	true if installation, false means upgrade

◆ print_upgrade_part_start()

print_upgrade_part_start	(	$plugin,
		$installation,
		$verbose )

Default start upgrade callback.

Parameters

string	$plugin
bool	$installation	true if installation, false means upgrade

◆ print_whole_category_list()

print_whole_category_list ( )

Deprecated: since 2.5

◆ process_environment_bypass()

process_environment_bypass	(		$xml,
		&	$result )

This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer.

Every bypass function must be defined in this file and it'll return true/false to decide if the original test is bypassed or no. Also such bypass functions are able to directly handling the result object although it should be only under exceptional conditions.

Parameters

string	xmldata containing the bypass data
object	result object to be updated

Return values

void

◆ process_environment_messages()

process_environment_messages	(		$xml,
		&	$result )

This function will detect if there is some message available to be added to the result in order to clarify enviromental details.

@uses INCORRECT_FEEDBACK_FOR_REQUIRED @uses INCORRECT_FEEDBACK_FOR_OPTIONAL

Parameters

string	xmldata containing the feedback data
object	reult object to be updated

◆ process_environment_restrict()

process_environment_restrict	(		$xml,
		&	$result )

This function will post-process the result record by executing the specified function, modifying it as necessary, also a custom message will be added to the result object to be printed by the display layer.

Every restrict function must be defined in this file and it'll return true/false to decide if the original test is restricted or no. Also such restrict functions are able to directly handling the result object although it should be only under exceptional conditions.

Parameters

string	xmldata containing the restrict data
object	result object to be updated

Return values

void

◆ process_environment_result()

process_environment_result	(		$element,
		&	$result )

Once the result has been determined, look in the XML for any messages, or other things that should be done depending on the outcome.

Parameters

array	$element	the element from the environment.xml file which may have children defining what should be done with the outcome.
object	$result	the result of the test, which may be modified by this function as specified in the XML.

◆ process_manual_revoke()

process_manual_revoke	(	$recipientid,
		$issuerid,
		$issuerrole,
		$badgeid )

Manually revoke awarded badges.

Parameters

int	$recipientid
int	$issuerid
int	$issuerrole
int	$badgeid

Return values

bool

◆ process_new_icon()

process_new_icon	(	$context,
		$component,
		$filearea,
		$itemid,
		$originalfile,
		$preferpng = false )

Stores optimised icon images in icon file area.

Since 2.9 this function will generate an icon in the same format as the original file when possible. To counter that behaviour, you can use the argument $preferpng to generate a PNG icon.

Parameters

context	$context
string	$component
	string	filearea
int	$itemid
string	$originalfile
boolean	$preferpng	When true, it will try to generate a PNG file regardless of the original file.

Return values

mixed new unique revision number or false if not saved

◆ profile_display_badges()

profile_display_badges ( )

Deprecated: since Moodle 2.9 MDL-45898 - please do not use this function any more.

◆ profiling_available()

profiling_available ( )

Whether PHP profiling is available.

This check ensures that one of the available PHP Profiling extensions is available.

Return values

bool

◆ profiling_export_generate()

profiling_export_generate	(	array	$runids,
			$tmpdir )

Generate the mpr contents (xml files) in the temporal directory.

Parameters

array	$runids	list of runids to be generated.
string	$tmpdir	filesystem fullpath of tmp generation.

Return values

boolean the mpr contents have been generated (true) or no (false).

◆ profiling_export_package()

profiling_export_package	(		$file,
			$tmpdir )

Package (zip) the mpr contents (xml files) in the final location.

Parameters

string	$file	filesystem fullpath to destination .mpr file.
string	$tmpdir	filesystem fullpath of tmp generation.

Return values

boolean the mpr contents have been generated (true) or no (false).

◆ profiling_export_runs()

profiling_export_runs	(	array	$runids,
			$file )

Export profiling runs to a .mpr (moodle profile runs) file.

This function gets an array of profiling runs (array of runids) and saves a .mpr file into destination for ulterior handling.

Format of .mpr files: mpr files are simple zip packages containing these files:

moodle_profiling_runs.xml: Metadata about the information exported. Contains some header information (version and release of moodle, database, git hash - if available, date of export...) and a list of all the runids included in the export.

runid.xml: One file per each run detailed in the main file, containing the raw dump of the given runid in the profiling table.

Possible improvement: Start storing some extra information in the profiling table for each run (moodle version, database, git hash...).

Parameters

array	$runids	list of runids to be exported.
string	$file	filesystem fullpath to destination .mpr file.

Return values

boolean the mpr file has been successfully exported (true) or no (false).

◆ profiling_get_flag()

profiling_get_flag ( $flag )

Check for profiling flags in all possible places.

Parameters

string $flag name

Return values

boolean

◆ profiling_get_import_main_schema()

profiling_get_import_main_schema ( )

Return the xml schema for the main import file.

Return values

string

◆ profiling_get_import_run_schema()

profiling_get_import_run_schema ( )

Return the xml schema for each individual run import file.

Return values

string

◆ profiling_get_script()

profiling_get_script ( )

Returns the path to the php script being requested.

Note this function is a partial copy of initialise_fullme() and setup_get_remote_url(), in charge of setting $FULLME, $SCRIPT and friends. To be used by early profiling runs in situations where $SCRIPT isn't defined yet

Return values

string absolute path (wwwroot based) of the script being executed

◆ profiling_import_runs()

profiling_import_runs	(		$file,
			$commentprefix = '' )

Import a .mpr (moodle profile runs) file into moodle.

See profiling_export_runs() for more details about the implementation of .mpr files.

Parameters

string	$file	filesystem fullpath to target .mpr file.
string	$commentprefix	prefix to add to the comments of all the imported runs.

Return values

boolean the mpr file has been successfully imported (true) or no (false).

◆ profiling_print_run()

profiling_print_run	(		$run,
			$prevreferences = null )

Generate the output to print a profiling run including further actions you can then take.

Parameters

object	$run	The profiling run object we are going to display.
array	$prevreferences	A list of run objects to list as comparison targets.

Return values

string The output to display on the screen for this run.

◆ proxy_log_callback()

proxy_log_callback ( $code )

Add http stream instrumentation.

This detects which any reads or writes to a php stream which uses the 'http' handler. Ideally 100% of traffic uses the Moodle curl libraries which do not use php streams.

Parameters

array $code stream callback code

◆ purge_all_caches()

purge_all_caches ( )

Invalidates browser caches and cached data in temp.

Return values

void

◆ purge_caches()

purge_caches ( $options = [] )

Selectively invalidate different types of cache.

Purges the cache areas specified. By default, this will purge all caches but can selectively purge specific areas alone or in combination.

Parameters

bool[] $options Specific parts of the cache to purge. Valid options are: 'muc' Purge MUC caches? 'theme' Purge theme cache? 'lang' Purge language string cache? 'js' Purge javascript cache? 'filter' Purge text filter cache? 'other' Purge all other caches?

◆ purge_other_caches()

purge_other_caches ( )

Purge all non-MUC caches not otherwise purged in purge_caches.

IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at phpunit_util::reset_dataroot()

◆ purify_html()

purify_html	(		$text,
			$options = array() )

KSES replacement cleaning function - uses HTML Purifier.

Parameters

string	$text	The (X)HTML string to purify
array	$options	Array of options; currently only option supported is 'allowid' (if set, does not remove id attributes when cleaning)

Return values

string

◆ put_records_csv()

put_records_csv ( )

Deprecated: since Moodle 3.2

See also: download_as_dataformat (lib/dataformatlib.php)

◆ qualified_me()

qualified_me ( )

Guesses the full URL of the current script.

This function is using $PAGE->url, but may fall back to $FULLME which is constructed from PHP_SELF and REQUEST_URI or SCRIPT_NAME

Return values

mixed full page URL string or false if unknown

◆ query_end()

query_end ( $result )

protected

This should be called immediately after each db query.

It does a clean up of resources.

Parameters

mixed $result The db specific result obtained from running a query.

Return values

void

◆ query_start()

query_start	(		$sql,
		?array	$params,
			$type,
			$extrainfo = null )

protected

Called before each db query.

Parameters

string	$sql
array \| null	$params	An array of parameters.
int	$type	type of query
mixed	$extrainfo	driver specific extra information

Return values

void

◆ question_add_context_in_key()

question_add_context_in_key ( $categories )

Add context in categories key.

Parameters

array $categories The list of categories.

Return values

array

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_add_tops()

question_add_tops ( )

Deprecated: since Moodle 3.5. MDL-61132

◆ question_category_delete_safe()

question_category_delete_safe ( $category )

Category is about to be deleted, 1/ All questions are deleted for this question category.

2/ Any questions that can't be deleted are moved to a new category NOTE: this function is called from lib/db/upgrade.php

Parameters

object | core_course_category $category course category object

◆ question_category_in_use()

question_category_in_use	(		$categoryid,
			$recursive = false )

Tests whether any question in a category is used by any part of Moodle.

Parameters

integer	$categoryid	a question category id.
boolean	$recursive	whether to check child categories too.

Return values

boolean whether any question in this category is in use.

◆ question_category_options()

question_category_options	(	$contexts,
		$top = false,
		$currentcat = 0,
		$popupform = false,
		$nochildrenof = -1,
		$escapecontextnames = true )

Output an array of question categories.

Parameters

array	$contexts	The list of contexts.
bool	$top	Whether to return the top categories or not.
int	$currentcat
bool	$popupform
int	$nochildrenof
boolean	$escapecontextnames	Whether the returned name of the thing is to be HTML escaped or not.

Return values

array

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_category_select_menu()

question_category_select_menu	(	$contexts,
		$top = false,
		$currentcat = 0,
		$selected = "",
		$nochildrenof = -1 )

Output a select menu of question categories.

Categories from this course and (optionally) published categories from other courses are included. Optionally, only categories the current user may edit can be included.

Parameters

array	$contexts
bool	$top
int	$currentcat
integer	$selected	optionally, the id of a category to be selected by default in the dropdown.
int	$nochildrenof

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_categorylist()

question_categorylist ( $categoryid )

Get the list of categories.

Parameters

int $categoryid

Return values

array of question category ids of the category and all subcategories.

◆ question_categorylist_parents()

question_categorylist_parents ( int $categoryid )

Get all parent categories of a given question category in descending order.

Parameters

int $categoryid for which you want to find the parents.

Return values

array of question category ids of all parents categories.

◆ question_context_has_any_questions()

question_context_has_any_questions ( $context )

Determine whether there are any questions belonging to this context, that is whether any of its question categories contain any questions.

This will return true even if all the questions are hidden.

Parameters

mixed $context either a context object, or a context id.

Return values

boolean whether any of the question categories beloning to this context have any questions in them.

◆ question_default_export_filename()

question_default_export_filename	(		$course,
			$category )

Create a reasonable default file name for exporting questions from a particular category.

Parameters

object	$course	the course the questions are in.
object	$category	the question category.

Return values

string the filename.

◆ question_delete_activity()

question_delete_activity	(		$cm,
			$notused = false )

All question categories and their questions are deleted for this activity.

Parameters

object	$cm	the course module object representing the activity
bool	$notused	the argument is not used any more. Kept for backwards compatibility.

Return values

boolean

◆ question_delete_context()

question_delete_context ( $contextid )

All question categories and their questions are deleted for this context id.

Parameters

int $contextid The contextid to delete question categories from

Return values

array only returns an empty array for backwards compatibility.

◆ question_delete_course()

question_delete_course	(		$course,
			$notused = false )

All question categories and their questions are deleted for this course.

Parameters

stdClass	$course	an object representing the activity
bool	$notused	this argument is not used any more. Kept for backwards compatibility.

Return values

bool	always true.

◆ question_delete_course_category()

question_delete_course_category	(	$category,
		$newcategory,
		$notused = false )

Category is about to be deleted, 1/ All question categories and their questions are deleted for this course category.

2/ All questions are moved to new category

Parameters

stdClass \| core_course_category	$category	course category object
stdClass \| core_course_category	$newcategory	empty means everything deleted, otherwise id of category where content moved
bool	$notused	this argument is no longer used. Kept for backwards compatibility.

Return values

boolean

◆ question_delete_question()

question_delete_question ( $questionid )

Deletes question and all associated data from the database.

It will not delete a question if it is used somewhere, instead it will just delete the reference.

Parameters

int $questionid The id of the question being deleted

◆ question_edit_url()

question_edit_url ( $context )

Gets the question edit url.

Parameters

object $context a context

Return values

string|bool A URL for editing questions in this context.

◆ question_extend_settings_navigation()

question_extend_settings_navigation	(	navigation_node	$navigationnode,
			$context,
			$baseurl = '/question/edit.php' )

Adds question bank setting links to the given navigation node if caps are met and loads the navigation from the plugins.

Qbank plugins can extend the navigation_plugin_base and add their own navigation node, this method will help to autoload those nodes in the question bank navigation.

Parameters

navigation_node	$navigationnode	The navigation node to add the question branch to
object	$context
string	$baseurl	the url of the base where the api is implemented from

Return values

navigation_node Returns the question branch that was added

◆ question_fix_top_names()

question_fix_top_names	(		$categories,
			$escape = true )

Finds top categories in the given categories hierarchy and replace their name with a proper localised string.

Parameters

array	$categories	An array of question categories.
boolean	$escape	Whether the returned name of the thing is to be HTML escaped or not.

Return values

array The same question category list given to the function, with the top category names being translated.

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_get_all_capabilities()

question_get_all_capabilities ( )

Get the question bank caps.

Return values

array all the question bank capabilities.

◆ question_get_default_category()

question_get_default_category ( $contextid )

Get the default category for the context.

Parameters

integer $contextid a context id.

Return values

object|bool the default question category for that context, or false if none.

◆ question_get_export_single_question_url()

question_get_export_single_question_url ( $question )

Get the URL to export a single question (exportone.php).

Parameters

stdClass | question_definition $question the question definition as obtained from question_bank\load_question_data() or question_bank\make_question(). (Only ->id and ->contextid are used.)

Return values

moodle_url the requested URL.

Deprecated: since Moodle 4.0

See also: qbank_exporttoxml\helper\question_get_export_single_question_url()

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_get_question_capabilities()

question_get_question_capabilities ( )

Get the array of capabilities for question.

Return values

array all the capabilities that relate to accessing particular questions.

◆ question_get_top_categories_for_contexts()

question_get_top_categories_for_contexts ( $contextids )

Gets the list of top categories in the given contexts in the array("categoryid,categorycontextid") format.

Parameters

array $contextids List of context ids

Return values

array

◆ question_get_top_category()

question_get_top_category	(		$contextid,
			$create = false )

Gets the top category in the given context.

This function can optionally create the top category if it doesn't exist.

Parameters

int	$contextid	A context id.
bool	$create	Whether create a top category if it doesn't exist.

Return values

bool|stdClass The top question category for that context, or false if none.

◆ question_has_capability_on()

question_has_capability_on	(	$questionorid,
		$cap,
		$notused = -1 )

Check capability on category.

Parameters

int \| stdClass \| question_definition	$questionorid	object or id. If an object is passed, it should include ->contextid and ->createdby.
string	$cap	'add', 'edit', 'view', 'use', 'move' or 'tag'.
int	$notused	no longer used.

Return values

bool	this user has the capability $cap for this question $question?

◆ question_hash()

question_hash ( $question )

Creates a stamp that uniquely identifies this version of the question.

In future we want this to use a hash of the question data to guarantee that identical versions have the same version stamp.

Parameters

object $question

Return values

string A unique version stamp

Deprecated: since Moodle 4.0

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_is_only_toplevel_category_in_context()

question_is_only_toplevel_category_in_context ( )

Deprecated: since Moodle 3.5. MDL-61132

◆ question_load_questions()

question_load_questions	(	$questionids,
		$extrafields = '',
		$join = '' )

Load a set of questions, given a list of ids.

The $join and $extrafields arguments can be used together to pull in extra data. See, for example, the usage in mod/quiz/attempt.php, and read the code below to see how the SQL is assembled. Throws exceptions on error.

Parameters

array	$questionids	array of question ids.
string	$extrafields	extra SQL code to be added to the query.
string	$join	extra SQL code to be added to the query.

Return values

array|string question objects.

◆ question_make_default_categories()

question_make_default_categories ( $contexts )

Gets the default category in the most specific context.

If no categories exist yet then default ones are created in all contexts.

Parameters

array $contexts The context objects for this context and all parent contexts.

Return values

object The default category - the category in the course context

◆ question_make_export_url()

question_make_export_url	(	$contextid,
		$categoryid,
		$format,
		$withcategories,
		$withcontexts,
		$filename )

Create url for question export.

Parameters

int	$contextid
int	$categoryid
string	$format
string	$withcategories
string	$withcontexts
string	$filename

Return values

moodle_url export file url

Deprecated: since Moodle 4.0 MDL-71573

See also: qbank_exportquestions\exportquestions_helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_module_uses_questions()

question_module_uses_questions ( $modname )

Does an activity module use the question bank?

Parameters

string $modname The name of the module (without mod_ prefix).

Return values

bool	true if the module uses questions.

◆ question_move_category_to_context()

question_move_category_to_context	(	$categoryid,
		$oldcontextid,
		$newcontextid )

This function helps move a question cateogry to a new context by moving all the files belonging to all the questions to the new context.

Also moves subcategories.

Parameters

integer	$categoryid	the id of the category being moved.
integer	$oldcontextid	the old context id.
integer	$newcontextid	the new context id.

◆ question_move_question_tags_to_new_context()

question_move_question_tags_to_new_context	(	array	$questions,
		context	$newcontext )

This function will handle moving all tag instances to a new context for a given list of questions.

Questions can be tagged in up to two contexts: 1.) The context the question exists in. 2.) The course context (if the question context is a higher context. E.g. course category context or system context.

This means a question that exists in a higher context (e.g. course cat or system context) may have multiple groups of tags in any number of child course contexts.

Questions in the course category context can be move "down" a context level into one of their child course contexts or activity contexts which affects the availability of that question in other courses / activities.

In this case it makes the questions no longer available in the other course or activity contexts so we need to make sure that the tag instances in those other contexts are removed.

Parameters

stdClass[]	$questions	The list of question being moved (must include the id and contextid)
context	$newcontext	The Moodle context the questions are being moved to

◆ question_move_questions_to_category()

question_move_questions_to_category	(		$questionids,
			$newcategoryid )

This function should be considered private to the question bank, it is called from question/editlib.php question/contextmoveq.php and a few similar places to to the work of actually moving questions and associated data.

However, callers of this function also have to do other work, which is why you should not call this method directly from outside the questionbank.

Parameters

array	$questionids	of question ids.
integer	$newcategoryid	the id of the category to move to.

Return values

bool

◆ question_page_type_list()

question_page_type_list	(	$pagetype,
		$parentcontext,
		$currentcontext )

Return a list of page types.

Parameters

string	$pagetype	current page type
stdClass	$parentcontext	Block's parent context
stdClass	$currentcontext	Current context of block

Return values

array

◆ question_pluginfile()

question_pluginfile	(	$course,
		$context,
		$component,
		$filearea,
		$args,
		$forcedownload,
		$options = [] )

Called by pluginfile.php to serve files related to the 'question' core component and for files belonging to qtypes.

For files that relate to questions in a question_attempt, then we delegate to a function in the component that owns the attempt (for example in the quiz, or in core question preview) to get necessary inforation.

(Note that, at the moment, all question file areas relate to questions in attempts, so the If at the start of the last paragraph is always true.)

Does not return, either calls send_file_not_found(); or serves the file.

Parameters

stdClass	$course	course settings object
stdClass	$context	context object
string	$component	the name of the component we are serving files for.
string	$filearea	the name of the file area.
array	$args	the remaining bits of the file path.
bool	$forcedownload	whether the user must be forced to download the file.
array	$options	additional options affecting the file serving

Return values

array|bool

◆ question_preload_questions()

question_preload_questions	(	$questionids = null,
		$extrafields = '',
		$join = '',
		$extraparams = [],
		$orderby = '' )

Given a list of ids, load the basic information about a set of questions from the questions table.

The $join and $extrafields arguments can be used together to pull in extra data. See, for example, the usage in {

See also: mod_quiz\quiz_attempt}, and read the code below to see how the SQL is assembled. Throws exceptions on error.

Parameters

array	$questionids	array of question ids to load. If null, then all questions matched by $join will be loaded.
string	$extrafields	extra SQL code to be added to the query.
string	$join	extra SQL code to be added to the query.
array	$extraparams	values for any placeholders in $join. You must use named placeholders.
string	$orderby	what to order the results by. Optional, default is unspecified order.

Return values

array partially complete question objects. You need to call get_question_options on them before they can be properly used.

◆ question_preview_popup_params()

question_preview_popup_params ( )

Popup params for the question preview.

Return values

array that can be passed as $params to the {

See also: popup_action()} constructor.

Deprecated: since Moodle 4.0

See also: qbank_previewquestion\previewquestion_helper\question_preview_popup_params()

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_preview_url()

question_preview_url	(	$questionid,
		$preferredbehaviour = null,
		$maxmark = null,
		$displayoptions = null,
		$variant = null,
		$context = null )

Generate the URL for starting a new preview of a given question with the given options.

Parameters

integer	$questionid	the question to preview.
string	$preferredbehaviour	the behaviour to use for the preview.
float	$maxmark	the maximum to mark the question out of.
question_display_options	$displayoptions	the display options to use.
int	$variant	the variant of the question to preview. If null, one will be picked randomly.
object	$context	context to run the preview in (affects things like filter settings, theme, lang, etc.) Defaults to $PAGE->context.

Return values

moodle_url the URL.

Deprecated: since Moodle 4.0

See also: qbank_previewquestion\helper\question_preview_url()

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_remove_stale_questions_from_category()

question_remove_stale_questions_from_category ( $categoryid )

Remove stale questions from a category.

While questions should not be left behind when they are not used any more, it does happen, maybe via restore, or old logic, or uncovered scenarios. When this happens, the users are unable to delete the question category unless they move those stale questions to another one category, but to them the category is empty as it does not contain anything. The purpose of this function is to detect the questions that may have gone stale and remove them.

You will typically use this prior to checking if the category contains questions.

The stale questions (unused and hidden to the user) handled are:

hidden questions
random questions

Parameters

int $categoryid The category ID.

Deprecated: since Moodle 4.0 MDL-71585

See also: qbank_managecategories\helper

Todo: Final deprecation on Moodle 4.4 MDL-72438

◆ question_reorder_qtypes()

question_reorder_qtypes	(	$sortedqtypes,
		$tomove,
		$direction )

Move one question type in a list of question types.

If you try to move one element off of the end, nothing will change.

Parameters

array	$sortedqtypes	An array $qtype => anything.
string	$tomove	one of the keys from $sortedqtypes
integer	$direction	+1 or -1

Return values

array an array $index => $qtype, with $index from 0 to n in order, and the $qtypes in the same order as $sortedqtypes, except that $tomove will have been moved one place.

◆ question_require_capability_on()

question_require_capability_on	(		$question,
			$cap )

Require capability on question.

Parameters

int \| stdClass \| question_definition	$question	object or id. If an object is passed, it should include ->contextid and ->createdby.
string	$cap	'add', 'edit', 'view', 'use', 'move' or 'tag'.

Return values

bool	true if the user has the capability. Throws exception if not.

◆ question_rewrite_question_preview_urls()

question_rewrite_question_preview_urls	(	$text,
		$questionid,
		$filecontextid,
		$filecomponent,
		$filearea,
		$itemid,
		$previewcontextid,
		$previewcomponent,
		$options = null )

Rewrite the PLUGINFILE urls in part of the content of a question, for use when viewing the question outside an attempt (for example, in the question bank listing or in the quiz statistics report).

Parameters

string	$text	the question text.
int	$questionid	the question id.
int	$filecontextid	the context id of the question being displayed.
string	$filecomponent	the component that owns the file area.
string	$filearea	the file area name.
int \| null	$itemid	the file's itemid
int	$previewcontextid	the context id where the preview is being displayed.
string	$previewcomponent	component responsible for displaying the preview.
array	$options	text and file options ('forcehttps'=>false)

Return values

string\$questiontext with URLs rewritten.

◆ question_save_from_deletion()

question_save_from_deletion	(	$questionids,
		$newcontextid,
		$oldplace,
		$newcategory = null )

Creates a new category to save the questions in use.

Parameters

array	$questionids	of question ids
object	$newcontextid	the context to create the saved category in.
string	$oldplace	a textual description of the think being deleted, e.g. from get_context_name
object	$newcategory

Return values

mixed false on

◆ question_save_qtype_order()

question_save_qtype_order	(		$neworder,
			$config = null )

Save a new question type order to the config_plugins table.

Parameters

array	$neworder	An arra $index => $qtype. Indices should start at 0 and be in order.
object	$config	get_config('question'), if you happen to have it around, to save one DB query.

◆ question_sort_tags()

question_sort_tags	(	$tagobjects,
		$categorycontext,
		$filtercourses = null )

Sort question tags by course or normal tags.

This function also search tag instances that may have a context id that don't match either a course or question context and fix the data setting the correct context id.

Parameters

core_tag_tag[]	$tagobjects	The tags for the given $question.
stdClass	$categorycontext	The question categories context.
stdClass[] \| null	$filtercourses	The courses to filter the course tags by.

Return values

stdClass\$sortedtagobjects Sorted tag objects.

◆ questions_in_use()

questions_in_use ( $questionids )

Check if the question is used.

Parameters

array $questionids of question ids.

Return values

boolean whether any of these questions are being used by any part of Moodle.

◆ raise_memory_limit()

raise_memory_limit ( $newlimit )

Function to raise the memory limit to a new value.

Will respect the memory limit if it is higher, thus allowing settings in php.ini, apache conf or command line switches to override it.

The memory limit should be expressed with a constant MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE. It is possible to use strings or integers too (eg:'128M').

Parameters

mixed $newlimit the new memory limit

Return values

bool success

◆ random_bytes_emulate()

random_bytes_emulate ( $length )

Try to generates cryptographically secure pseudo-random bytes.

Note this is achieved by fallbacking between:

PHP 7 random_bytes().
OpenSSL openssl_random_pseudo_bytes().
In house random generator getting its entropy from various, hard to guess, pseudo-random sources.

Parameters

int $length requested length in bytes

Return values

string binary data

◆ random_string()

random_string ( $length = 15 )

Generate and return a random string of the specified length.

Parameters

int $length The length of the string to be created.

Return values

string

◆ raw_connect()

raw_connect	(	string	$dbhost,
		string	$dbuser,
		string	$dbpass,
		string	$dbname,
			$prefix,
		array	$dboptions = null )

abstractprotected

Connect to db The real connection establisment, called from connect() and set_dbhwrite()

Parameters

string	$dbhost	The database host.
string	$dbuser	The database username.
string	$dbpass	The database username's password.
string	$dbname	The name of the database being connected to.
mixed	$prefix	string means moodle db prefix, false used for external databases where prefix not used
array	$dboptions	driver specific options

Return values

bool true

Exceptions

dml_connection_exception if error

◆ rc4decrypt()

rc4decrypt ( $data )

rc4decrypt

Parameters

string $data Data to decrypt.

Return values

string The now decrypted data.

◆ rc4encrypt()

rc4encrypt ( $data )

rc4encrypt

Parameters

string $data Data to encrypt.

Return values

string The now encrypted data.

◆ rebuild_contexts()

rebuild_contexts ( )

Deprecated: since 2.2

◆ rebuild_course_cache()

moodle_database rebuild_course_cache	(	int	$courseid = 0,
		bool	$clearonly = false,
		bool	$partialrebuild = false )

Rebuilds or resets the cached list of course activities stored in MUC.

rebuild_course_cache() must NEVER be called from lib/db/upgrade.php. At the same time course cache may ONLY be cleared using this function in upgrade scripts of plugins.

During the bulk operations if it is necessary to reset cache of multiple courses it is enough to call increment_revision_number() for the table 'course' and field 'cacherev' specifying affected courses in select.

Cached course information is stored in MUC core/coursemodinfo and is validated with the DB field {course}.cacherev

$DB

Parameters

int	$courseid	id of course to rebuild, empty means all
boolean	$clearonly	only clear the cache, gets rebuild automatically on the fly. Recommended to set to true to avoid unnecessary multiple rebuilding.
boolean	$partialrebuild	will not delete the whole cache when it's true. use purge_module_cache() or purge_section_cache() must be called before when partialrebuild is true. use purge_module_cache() to invalidate mod cache. use purge_section_cache() to invalidate section cache.

Return values

void

Exceptions

◆ rebuildnolinktag()

rebuildnolinktag ( $text )

This function is used to rebuild the <nolink> tag because some formats (PLAIN and WIKI) will transform it to html entities.

Parameters

string $text Text to search for nolink tag in

Return values

string

◆ recaptcha_check_response()

recaptcha_check_response	(	$verifyurl,
		$privkey,
		$remoteip,
		$response )

Calls an HTTP POST function to verify if the user's response was correct.

Parameters

string	$verifyurl	URL for reCAPTCHA verification
string	$privkey	The private key for reCAPTCHA
string	$remoteip	The user's IP
string	$response	The response from reCAPTCHA

Return values

ReCaptchaResponse

◆ recaptcha_get_challenge_html()

recaptcha_get_challenge_html	(	$apiurl,
		$pubkey,
		$lang = null )

Gets the challenge HTML This is called from the browser, and the resulting reCAPTCHA HTML widget is embedded within the HTML form it was called from.

Parameters

string	$apiurl	URL for reCAPTCHA API
string	$pubkey	The public key for reCAPTCHA
string	$lang	Language to use. If not provided, get current language.

Return values

string - The HTML to be embedded in the user's form.

◆ recaptcha_lang()

recaptcha_lang ( $lang = null )

Returns the language code the reCAPTCHA element should use.

Google reCAPTCHA uses different language codes than Moodle so we must convert. https://developers.google.com/recaptcha/docs/language

Parameters

string $lang Language to use. If not provided, get current language.

Return values

string A language code

◆ redirect()

redirect	(	$url,
		$message = '',
		$delay = null,
		$messagetype = core\output\notification::NOTIFY_INFO )

Redirects the user to another page, after printing a notice.

This function calls the OUTPUT redirect method, echo's the output and then dies to ensure nothing else happens.

Good practice: You should call this method before starting page output by using any of the OUTPUT methods.

Parameters

moodle_url \| string	$url	A moodle_url to redirect to. Strings are not to be trusted!
string	$message	The message to display to the user
int	$delay	The delay before redirecting
string	$messagetype	The type of notification to show the message in. See constants on core\output\notification.

Exceptions

◆ reduce_memory_limit()

reduce_memory_limit ( $newlimit )

Function to reduce the memory limit to a new value.

Will respect the memory limit if it is lower, thus allowing settings in php.ini, apache conf or command line switches to override it

The memory limit should be expressed with a string (eg:'64M')

Parameters

string $newlimit the new memory limit

Return values

bool

◆ remoteip_in_list()

remoteip_in_list ( $list )

Is the current ip in a given list?

Parameters

string $list

Return values

bool

◆ remove_course_contents()

remove_course_contents	(		$courseid,
			$showfeedback = true,
		array	$options = null )

Clear a course out completely, deleting all content but don't delete the course itself.

This function does not verify any permissions.

Please note this function also deletes all user enrolments, enrolment instances and role assignments by default.

$options:

'keep_roles_and_enrolments' - false by default
'keep_groups_and_groupings' - false by default

Parameters

int	$courseid	The id of the course that is being deleted
bool	$showfeedback	Whether to display notifications of each action the function performs.
array	$options	extra options

Return values

bool	true if all the removals succeeded. false if there were any failures. If this method returns false, some of the removals will probably have succeeded, and others failed, but you have no way of knowing which.

◆ remove_dir()

remove_dir	(		$dir,
			$contentonly = false )

Delete directory or only its content.

Parameters

string	$dir	directory path
bool	$contentonly

Return values

bool	success, true also if dir does not exist

◆ rename_to_unused_name()

rename_to_unused_name	(	string	$filepath,
		string	$prefix = '_temp_' )

Renames a file or directory to a unique name within the same directory.

This function is designed to avoid any potential race conditions, and select an unused name.

Parameters

string	$filepath	Original filepath
string	$prefix	Prefix to use for the temporary name

Return values

string|bool New file path or false if failed

Since: Moodle 3.10

◆ replace_ampersands_not_followed_by_entity()

replace_ampersands_not_followed_by_entity ( $string )

Given a string, performs a negative lookahead looking for any ampersand character that is not followed by a proper HTML entity.

If any is found, it is replaced by &. The string is then returned.

Parameters

string $string

Return values

string

◆ report_insights_context_insights()

report_insights_context_insights ( \context $context )

Deprecated: since Moodle 3.8

◆ require_admin()

require_admin ( )

A convenience function for where we must be logged in as admin.

Return values

void

◆ require_phpunit_isolation()

require_phpunit_isolation ( )

A helper function for deprecated files to use to ensure that, when they are included for unit tests, they are run in an isolated process.

Exceptions

coding_exception The exception thrown when the process is not isolated.

◆ require_user_key_login()

require_user_key_login	(	$script,
		$instance = null,
		$keyvalue = null )

Require key login.

Function terminates with error if key not found or incorrect.

@uses NO_MOODLE_COOKIES @uses PARAM_ALPHANUM

Parameters

string	$script	unique script identifier
int	$instance	optional instance id
string	$keyvalue	The key. If not supplied, this will be fetched from the current session.

Return values

int	Instance ID

◆ required_param()

required_param	(		$parname,
			$type )

Returns a particular value for the named variable, taken from POST or GET.

If the parameter doesn't exist then an error is thrown because we require this variable.

This function should be used to initialise all required values in a script that are based on parameters. Usually it will be used like this: $id = required_param('id', PARAM_INT);

Please note the $type parameter is now required and the value can not be array.

Parameters

string	$parname	the name of the page parameter we want
string	$type	expected type of parameter

Return values

mixed

Exceptions

◆ required_param_array()

required_param_array	(		$parname,
			$type )

Returns a particular array value for the named variable, taken from POST or GET.

If the parameter doesn't exist then an error is thrown because we require this variable.

This function should be used to initialise all required values in a script that are based on parameters. Usually it will be used like this: $ids = required_param_array('ids', PARAM_INT);

Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported

Parameters

string	$parname	the name of the page parameter we want
string	$type	expected type of parameter

Return values

array

Exceptions

◆ reset_course_userdata()

reset_course_userdata ( $data )

This function will empty a course of user data.

It will retain the activities and the structure of the course.

Parameters

object $data an object containing all the settings including courseid (without magic quotes)

Return values

array status array of array component, item, error

◆ reset_login_count()

reset_login_count ( )

Deprecated

◆ reset_password_and_mail()

reset_password_and_mail ( $user )

Resets specified user's password and send the new password to the user via email.

Parameters

stdClass $user A $USER object

Return values

bool	Returns true if mail was sent OK and false if there was an error.

◆ reset_text_filters_cache()

reset_text_filters_cache ( $phpunitreset = false )

Resets some data related to filters, called during upgrade or when general filter settings change.

Parameters

bool $phpunitreset true means called from our PHPUnit integration test reset

Return values

void

◆ resize_image()

resize_image	(	$filepath,
		$width,
		$height,
		$forcecanvas = false )

Resize an image from an image path.

This maintains the aspect ratio of the image. This will not enlarge the image.

Parameters

string	$filepath	The full path to the original image file.
int \| null	$width	The max width of the resized image, or null to only use the height.
int \| null	$height	The max height of the resized image, or null to only use the width.
bool	$forcecanvas	Whether the final dimensions should be set to $width and $height.

Return values

string|bool False if a problem occurs, else the resized image data.

◆ resize_image_from_image()

resize_image_from_image	(	$original,
		$imageinfo,
		$width,
		$height,
		$forcecanvas = false )

Resize an image from an image object.

Parameters

resource \| GdImage	$original	The image to work on.
array	$imageinfo	Contains [0] => originalwidth, [1] => originalheight.
int \| null	$width	The max width of the resized image, or null to only use the height.
int \| null	$height	The max height of the resized image, or null to only use the width.
bool	$forcecanvas	Whether the final dimensions should be set to $width and $height.

Return values

string|bool False if a problem occurs, else the resized image data.

◆ resourcelib_embed_general()

resourcelib_embed_general	(	$fullurl,
		$title,
		$clicktoopen,
		$mimetype )

Returns general link or file embedding html.

Parameters

string	$fullurl
string	$title
string	$clicktoopen
string	$mimetype

Return values

string html

◆ resourcelib_embed_image()

resourcelib_embed_image	(		$fullurl,
			$title )

Returns image embedding html.

Parameters

string	$fullurl
string	$title

Return values

string html

◆ resourcelib_embed_pdf()

resourcelib_embed_pdf	(	$fullurl,
		$title,
		$clicktoopen )

Returns general link or pdf embedding html.

Parameters

string	$fullurl
string	$title
string	$clicktoopen

Return values

string html

◆ resourcelib_get_displayoptions()

resourcelib_get_displayoptions	(	array	$enabled,
			$current = null )

Returns list of available display options.

Parameters

array	$enabled	list of options enabled in module configuration
int	$current	current display options for existing instances

Return values

array of key=>name pairs

◆ resourcelib_get_extension()

resourcelib_get_extension ( $fullurl )

Looks for the extension.

Parameters

string $fullurl

Return values

string file extension

◆ resourcelib_guess_url_mimetype()

resourcelib_guess_url_mimetype ( $fullurl )

Tries to guess correct mimetype for arbitrary URL.

Parameters

string $fullurl

Return values

string mimetype

◆ resourcelib_try_file_migration()

resourcelib_try_file_migration	(	$filepath,
		$cmid,
		$courseid,
		$component,
		$filearea,
		$itemid )

Try on demand migration of file from old course files.

Parameters

string	$filepath	old file path
int	$cmid	migrated course module if
int	$courseid
string	$component
string	$filearea	new file area
int	$itemid	migrated file item id

Return values

mixed,false if not found, stored_file instance if migrated to new area

◆ restrict_php_version()

restrict_php_version	(	&	$result,
			$version )

Check if the current PHP version is greater than or equal to an unsupported version.

Parameters

object	$result	an environment_results instance
string	$version	the version of PHP that can't be used

Return values

bool	result of version check

◆ restrict_php_version_7()

restrict_php_version_7 ( & $result )

Check if the current PHP version is greater than or equal to PHP version 7.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_71()

restrict_php_version_71 ( & $result )

Check if the current PHP version is greater than or equal to PHP version 7.1.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_72()

restrict_php_version_72 ( & $result )

Check if the current PHP version is greater than or equal to PHP version 7.2.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_73()

restrict_php_version_73 ( & $result )

Check if the current PHP version is greater than or equal to PHP version 7.3.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_74()

restrict_php_version_74 ( & $result )

Check if the current PHP version is greater than or equal to PHP version 7.4.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_80()

restrict_php_version_80 ( $result )

Check if the current PHP version is greater than or equal to PHP version 8.0.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_81()

restrict_php_version_81 ( $result )

Check if the current PHP version is greater than or equal to PHP version 8.1.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_82()

restrict_php_version_82 ( $result )

Check if the current PHP version is greater than or equal to PHP version 8.2.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ restrict_php_version_83()

restrict_php_version_83 ( $result )

Check if the current PHP version is greater than or equal to PHP version 8.3.

Parameters

object $result an environment_results instance

Return values

bool	result of version check

◆ right_to_left()

right_to_left ( )

Returns true if the user is using a right-to-left language.

Return values

boolean true if the current language is right-to-left (Hebrew, Arabic etc)

◆ s()

s ( $var )

Add quotes to HTML characters.

Returns $var with HTML characters (like "<", ">", etc.) properly quoted. Related function p() simply prints the output of this function.

Parameters

string $var the string potentially containing HTML characters

Return values

string

◆ search_generate_SQL()

object search_generate_SQL	(	$parsetree,
		$datafield,
		$metafield,
		$mainidfield,
		$useridfield,
		$userfirstnamefield,
		$userlastnamefield,
		$timefield,
		$instancefield,
		$tagfields = [] )

Primitive function to generate a SQL string from a parse tree.

Parameters:

$parsetree should be a parse tree generated by a search_lexer/search_parser combination. Other fields are database table names to search.

@global object

◆ search_generate_text_SQL()

search_generate_text_SQL	(	$parsetree,
		$datafield,
		$metafield,
		$mainidfield,
		$useridfield,
		$userfirstnamefield,
		$userlastnamefield,
		$timefield,
		$instancefield )

Primitive function to generate a SQL string from a parse tree using TEXT indexes.

If searches aren't suitable to use TEXT this function calls the default search_generate_SQL() one.

Deprecated: since Moodle 2.9 MDL-48939

Todo: MDL-48940 This will be deleted in Moodle 3.2

See also: search_generate_SQL()

◆ search_users()

object search_users	(		$courseid,
			$groupid,
			$searchtext,
			$sort = '',
		array	$exceptions = null )

Search through course users.

If $coursid specifies the site course then this function searches through all undeleted and confirmed users

@uses SITEID @uses SQL_PARAMS_NAMED @uses CONTEXT_COURSE

Parameters

int	$courseid	The course in question.
int	$groupid	The group in question.
string	$searchtext	The string to search for
string	$sort	A field to sort by
array	$exceptions	A list of IDs to ignore, eg 2,4,5,8,9,10

Return values

array

◆ select_db_handle()

select_db_handle	(	int	$type,
		string	$sql )

protected

Select appropriate db handle - readwrite or readonly.

Parameters

int	$type	type of query
string	$sql

Return values

void

◆ send_confirmation_email()

send_confirmation_email	(		$user,
			$confirmationurl = null )

Send email to specified user with confirmation text and activation link.

Parameters

stdClass	$user	A $USER object
string	$confirmationurl	user confirmation URL

Return values

bool	Returns true if mail was sent OK and false if there was an error.

◆ send_headers()

send_headers	(		$contenttype,
			$cacheable = true )

Send the HTTP headers that Moodle requires.

There is a backwards compatibility hack for legacy code that needs to add custom IE compatibility directive.

Example: if (!isset($CFG->additionalhtmlhead)) { $CFG->additionalhtmlhead = ''; } $CFG->additionalhtmlhead .= '<meta http-equiv="X-UA-Compatible" content="IE=8" >'; header('X-UA-Compatible: IE=8'); echo $OUTPUT->header();

Please note the $CFG->additionalhtmlhead alone might not work, you should send the IE compatibility header() too.

Parameters

string	$contenttype
bool	$cacheable	Can this page be cached on back?

Return values

void,sends HTTP headers

◆ send_password_change_confirmation_email()

send_password_change_confirmation_email	(		$user,
			$resetrecord )

Sends a password change confirmation email.

Parameters

stdClass	$user	A $USER object
stdClass	$resetrecord	An object tracking metadata regarding password reset request

Return values

bool	Returns true if mail was sent OK and false if there was an error.

◆ send_password_change_info()

send_password_change_info ( $user )

Sends an email containing information on how to change your password.

Parameters

stdClass $user A $USER object

Return values

bool	Returns true if mail was sent OK and false if there was an error.

◆ serialise_tool_proxy()

serialise_tool_proxy ( )

Deprecated: since 3.10

◆ session_get_instance()

session_get_instance ( )

Deprecated: since 2.6

◆ session_get_realuser()

session_get_realuser ( )

Deprecated: since 2.6

◆ session_is_legacy()

session_is_legacy ( )

Deprecated: since 2.6

◆ session_is_loggedinas()

session_is_loggedinas ( )

Deprecated: since 2.6

◆ session_kill()

session_kill ( )

Deprecated: since 2.6

◆ session_kill_all()

session_kill_all ( )

Deprecated: since 2.6

◆ session_kill_user()

session_kill_user ( )

Deprecated: since 2.6

◆ session_loginas()

session_loginas ( )

Deprecated: since 2.6

◆ session_set_user()

session_set_user ( )

Deprecated: since 2.6

◆ session_touch()

session_touch ( )

Deprecated: since 2.6

◆ sesskey()

sesskey ( )

Makes sure that $USER->sesskey exists, if $USER itself exists.

It sets a new sesskey if one does not already exist, but does not overwrite existing sesskeys. Returns the sesskey string if $USER exists, or boolean false if not.

@uses $USER

Return values

string

◆ set_bounce_count()

set_bounce_count	(		$user,
			$reset = false )

Increment or reset user's email bounce count.

Parameters

stdClass	$user	object containing an id
bool	$reset	will reset the count to 0

◆ set_cache_flag()

set_cache_flag	(	$type,
		$name,
		$value,
		$expiry = null )

Set a volatile flag.

Parameters

string	$type	the "type" namespace for the key
string	$name	the key to set
string	$value	the value to set (without magic quotes) - null will remove the flag
int	$expiry	(optional) epoch indicating expiry - defaults to now()+ 24hs

Return values

bool	Always returns true

◆ set_config()

set_config	(	$name,
		$value,
		$plugin = null )

Set a key in global configuration.

Set a key/value pair in both this session's $CFG global variable and in the 'config' database table for future sessions.

Can also be used to update keys for plugin-scoped configs in config_plugin table. In that case it doesn't affect $CFG.

A NULL value will delete the entry.

NOTE: this function is called from lib/db/upgrade.php

Parameters

string	$name	the key to set
string	$value	the value to set (without magic quotes)
string	$plugin	(optional) the plugin scope, default null

Return values

bool	true or exception

◆ set_cron_lock()

set_cron_lock	(	$name,
		$until,
		$ignorecurrent = false )

Try to obtain or release the cron lock.

Parameters

string	$name	name of lock
int	$until	timestamp when this lock considered stale, null means remove lock unconditionally
bool	$ignorecurrent	ignore current lock state, usually extend previous lock, defaults to false

Return values

bool	true if lock obtained

◆ set_current_group()

set_current_group ( )

Deprecated: Since year 2006 - please do not use this function any more.

◆ set_db_handle()

set_db_handle ( $dbh )

abstractprotected

Sets db handle to be used with subsequent queries.

Parameters

resource $dbh

Return values

void

◆ set_debugging()

set_debugging	(		$level,
			$debugdisplay = null )

Alter debugging level for the current request, the change is not saved in database.

Parameters

int	$level	one of the DEBUG_* constants
bool	$debugdisplay

◆ set_mnet_remote_client()

set_mnet_remote_client ( $client )

during the xmlrpc server code execution, this will be called to setup the object returned by get_mnet_remote_client

Parameters

mnet_remote_client $client the client to set up

Exceptions

◆ set_moodle_cookie()

set_moodle_cookie ( $username )

Sets a moodle cookie with a weakly encrypted username.

Parameters

string $username to encrypt and place in a cookie, '' means delete current cookie

Return values

void

◆ set_send_count()

set_send_count	(		$user,
			$reset = false )

Used to increment or reset email sent count.

Parameters

stdClass	$user	object containing an id
bool	$reset	will reset the count to 0

Return values

void

◆ set_user_device_type()

set_user_device_type ( )

Deprecated: since 2.6

◆ set_user_preference()

set_user_preference	(	$name,
		$value,
		$user = null )

Sets a preference for the specified user.

If a $user object is submitted it's 'preference' property is used for the preferences cache.

When additional validation/permission check is needed it is better to use {

See also: useredit_update_user_preference()}

Parameters

string	$name	The key to set as preference for the specified user
string	$value	The value to set for the $name key in the specified user's record, null means delete current value.
stdClass \| int \| null	$user	A moodle user object or id, null means current user

Exceptions

Return values

bool	Always true or exception

◆ set_user_preferences()

set_user_preferences	(	array	$prefarray,
			$user = null )

Sets a whole array of preferences for the current user.

If a $user object is submitted it's 'preference' property is used for the preferences cache.

Parameters

array	$prefarray	An array of key/value pairs to be set
stdClass \| int \| null	$user	A moodle user object or id, null means current user

Return values

bool	Always true or exception

◆ setnew_password_and_mail()

setnew_password_and_mail	(		$user,
			$fasthash = false )

Sets specified user's password and send the new password to the user via email.

Parameters

stdClass	$user	A $USER object
bool	$fasthash	If true, use a low cost factor when generating the hash for speed.

Return values

bool|string Returns "true" if mail was sent OK and "false" if there was an error

◆ setup()

moodle_text_filter::setup	(		$page,
			$context )

Setup page with filter requirements and other prepare stuff.

Override this method if the filter needs to setup page requirements or needs other stuff to be executed.

Note this method is invoked from {

See also: setup_page_for_filters()} for each piece of text being filtered, so it is responsible for controlling its own execution cardinality.

Parameters

moodle_page	$page	the page we are going to add requirements to.
context	$context	the context which contents are going to be filtered.

Since: Moodle 2.3

Reimplemented in filter_glossary, filter_mathjaxloader, and filter_mediaplugin.

◆ setup_DB()

stdClass setup_DB ( )

Sets up global $DB moodle_database instance.

$CFG The global configuration instance.

See also: config.php; config-dist.php @global stdClass $DB The global moodle_database instance.

Return values

void|bool Returns true when finished setting up $DB. Returns void when $DB has already been set.

◆ setup_get_remote_url()

setup_get_remote_url ( )

Get the URL that PHP/the web server thinks it is serving.

Private function used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.

Return values

array in the same format that parse_url returns, with the addition of a 'fullpath' element, which includes any slasharguments path.

◆ setup_page_for_filters()

filter_manager::setup_page_for_filters	(		$page,
			$context )

Setup page with filters requirements and other prepare stuff.

This method is used by {

See also: format_text()} and {; format_string()} in order to allow filters to setup any page requirement (js, css...) or perform any action needed to get them prepared before filtering itself happens by calling to each every active setup() method.

Note it's executed for each piece of text filtered, so filter implementations are responsible of controlling the cardinality of the executions that may be different depending of the stuff to prepare.

Parameters

moodle_page	$page	the page we are going to add requirements to.
context	$context	the context which contents are going to be filtered.

Since: Moodle 2.3

◆ setup_page_for_globally_available_filters()

filter_manager::setup_page_for_globally_available_filters ( $page )

Setup the page for globally available filters.

This helps setting up the page for filters which may be applied to the page, even if they do not belong to the current context, or are not yet visible because the content is lazily added (ajax). This method always uses to the system context which determines the globally available filters.

This should only ever be called once per request.

Parameters

moodle_page $page The page.

Since: Moodle 3.2

◆ shift_course_mod_dates()

shift_course_mod_dates	(	$modname,
		$fields,
		$timeshift,
		$courseid,
		$modid = 0 )

Change dates in module - used from course reset.

Parameters

string	$modname	forum, assignment, etc
array	$fields	array of date fields from mod table
int	$timeshift	time difference
int	$courseid
int	$modid	(Optional) passed if specific mod instance in course needs to be updated.

Return values

bool success

◆ shorten_filename()

shorten_filename	(	$filename,
		$length = MAX_FILENAME_SIZE,
		$includehash = false )

Shortens a given filename by removing characters positioned after the ideal string length.

When the filename is too long, the file cannot be created on the filesystem due to exceeding max byte size. Limiting the filename to a certain size (considering multibyte characters) will prevent this.

Parameters

string	$filename	file name
int	$length	ideal string length
bool	$includehash	Whether to include a file hash in the shortened version. This ensures uniqueness.

Return values

string\$shortened shortened file name

◆ shorten_filenames()

shorten_filenames	(	array	$path,
			$length = MAX_FILENAME_SIZE,
			$includehash = false )

Shortens a given array of filenames by removing characters positioned after the ideal string length.

Parameters

array	$path	The paths to reduce the length.
int	$length	Ideal string length
bool	$includehash	Whether to include a file hash in the shortened version. This ensures uniqueness.

Return values

array\$result Shortened paths in array.

◆ shorten_text()

shorten_text	(	$text,
		$ideal = 30,
		$exact = false,
		$ending = '...' )

Given some text (which may contain HTML) and an ideal length, this function truncates the text neatly on a word boundary if possible.

Parameters

string	$text	text to be shortened
int	$ideal	ideal string length
boolean	$exact	if false, $text will not be cut mid-word
string	$ending	The string to append if the passed string is truncated

Return values

string\$truncate shortened string

◆ show_event()

show_event ( )

Deprecated: please use calendar_event->toggle_visibility(true) instead.

◆ signup_captcha_enabled()

signup_captcha_enabled ( )

Returns whether or not the captcha element is enabled, and the admin settings fulfil its requirements.

Return values

bool

◆ signup_get_user_confirmation_authplugin()

signup_get_user_confirmation_authplugin ( )

Check if user confirmation is enabled on this site and return the auth plugin handling registration if enabled.

Return values

stdClass the current auth plugin handling user registration or false if registration not enabled

Since: Moodle 3.2

◆ signup_is_enabled()

signup_is_enabled ( )

Check if sign-up is enabled in the site.

If is enabled, the function will return the authplugin instance.

Return values

mixed false if sign-up is not enabled, the authplugin instance otherwise.

Since: Moodle 3.2

◆ signup_setup_new_user()

signup_setup_new_user ( $user )

Add the missing fields to a user that is going to be created.

Parameters

stdClass $user the new user object

Return values

stdClass the user filled

Since: Moodle 3.2

◆ signup_validate_data()

signup_validate_data	(		$data,
			$files )

Validates the standard sign-up data (except recaptcha that is validated by the form element).

Parameters

array	$data	the sign-up data
array	$files	files among the data

Return values

array list of errors, being the key the data element name and the value the error itself

Since: Moodle 3.2

◆ site_is_public()

site_is_public ( )

Tries to guess if $CFG->wwwroot is publicly accessible or not.

Never put your faith on this function and rely on its accuracy as there might be false positives. It just performs some simple checks, and mainly is used for places where we want to hide some options such as site registration when $CFG->wwwroot is not publicly accessible. Good thing is there is no false negative. Note that it's possible to force the result of this check by specifying $CFG->site_is_public in config.php

Return values

bool

◆ site_scale_used()

site_scale_used ( )

Deprecated: since Moodle 3.1

◆ skip_main_destination()

skip_main_destination ( )

Deprecated: use $OUTPUT->skip_link_target() in instead.

◆ soap_call()

soap_call	(	$connection,
		$call,
		$params )

Make a call to a SoapClient.

Parameters

SoapClient	$connection	The SoapClient to call
string	$call	Operation to be performed by client
array	$params	Parameters for the call

Return values

mixed The return parameters of the operation or a SoapFault If the operation returned several parameters then these are returned as an object rather than an array

◆ soap_connect()

soap_connect	(		$wsdl,
			$trace = false )

Create a new SoapClient object.

Parameters

string	$wsdl	URI of the WSDL file
boolean	$trace	indicates if the soap messages should be saved (i.e. if get_soap_messages is used) and should be used only for debugging

Return values

mixed Returns either a SoapClient object or, if the connection failed, a SoapFault object.

◆ sort_categories_by_tree()

sort_categories_by_tree	(	&	$categories,
			$id = 0,
			$level = 1 )

Returns the categories with their names ordered following parent-child relationships.

finally it tries to return pending categories (those being orphaned, whose parent is incorrect) to avoid missing any category from original array.

Parameters

array	$categories
int	$id
int	$level

Return values

array

◆ start_delegated_transaction()

start_delegated_transaction ( )

On DBs that support it, switch to transaction mode and begin a transaction.

Return values

moodle_transaction

◆ stats_cron_daily()

stats_cron_daily ( $maxdays = 1 )

Execute daily statistics gathering.

Parameters

int $maxdays maximum number of days to be processed

Return values

boolean success

◆ stats_cron_monthly()

stats_cron_monthly ( )

Execute monthly statistics gathering.

Return values

boolean success

◆ stats_cron_weekly()

stats_cron_weekly ( )

Execute weekly statistics gathering.

Return values

boolean success

◆ stats_fix_zeros()

stats_fix_zeros	(	$stats,
		$timeafter,
		$timestr,
		$line2 = true,
		$line3 = false )

Fix missing entries in the statistics.

This creates a dummy stat when nothing happened during a day/week/month.

Parameters

array	$stats	array of statistics.
int	$timeafter	unused.
string	$timestr	type of statistics to generate (dayly, weekly, monthly).
boolean	$line2
boolean	$line3

Return values

array of fixed statistics.

◆ stats_get_base_daily()

stats_get_base_daily ( $time = 0 )

Start of day.

Parameters

int $time timestamp

Return values

int	start of day

◆ stats_get_base_monthly()

stats_get_base_monthly ( $time = 0 )

Start of month.

Parameters

int $time timestamp

Return values

int	start of month

◆ stats_get_base_weekly()

stats_get_base_weekly ( $time = 0 )

Start of week.

Parameters

int $time timestamp

Return values

int	start of week

◆ stats_get_next_day_start()

stats_get_next_day_start ( $time )

Start of next day.

Parameters

int $time timestamp

Return values

start of next day

◆ stats_get_next_month_start()

stats_get_next_month_start ( $time )

Start of next month.

Parameters

int $time timestamp

Return values

start of next month

◆ stats_get_next_week_start()

stats_get_next_week_start ( $time )

Start of next week.

Parameters

int $time timestamp

Return values

start of next week

◆ stats_get_start_from()

stats_get_start_from ( $str )

Return starting date of stats processing.

Parameters

string $str name of table - daily, weekly or monthly

Return values

int timestamp

◆ stats_progress()

stats_progress ( $ident )

Print daily cron progress.

Parameters

string $ident

◆ stats_run_query()

stats_run_query	(		$sql,
			$parameters = array() )

Execute individual daily statistics queries.

Parameters

string $sql The query to run

Return values

boolean success

◆ stats_temp_table_clean()

stats_temp_table_clean ( )

Deletes summary logs table for stats calculation.

Return values

bool	success (true) or failure(false)

◆ stats_temp_table_fill()

stats_temp_table_fill	(		$timestart,
			$timeend )

Fills the temporary stats tables with new data.

This function is meant to be called to get a new day of data

Parameters

int	timestamp of the start time of logs view
int	timestamp of the end time of logs view

Return values

bool	success (true) or failure(false)

◆ stats_temp_table_setup()

stats_temp_table_setup ( )

Fills the temporary stats tables with new data.

This function is meant to be called once at the start of stats generation

Parameters

int	timestart timestamp of the start time of logs view
int	timeend timestamp of the end time of logs view

Return values

bool	success (true) or failure(false)

◆ strip_links()

strip_links ( $string )

Given a string, replaces all .

* by .* and returns the string.

Parameters

string $string

Return values

string

◆ strip_pluginfile_content()

strip_pluginfile_content ( $source )

Removes the usage of Moodle files from a text.

In some rare cases we need to re-use a text that already has embedded links to some files hosted within Moodle. But the new area in which we will push this content does not support files... therefore we need to remove those files.

Parameters

string $source The text

Return values

string The stripped text

◆ strip_querystring()

strip_querystring ( $url )

Remove query string from url.

Takes in a URL and returns it without the querystring portion.

Parameters

string $url the url which may have a query string attached.

Return values

string The remaining URL.

◆ swapshuffle()

swapshuffle ( $array )

Given a simple array, this shuffles it up just like shuffle() Unlike PHP's shuffle() this function works on any machine.

Parameters

array $array The array to be rearranged

Return values

array

◆ swapshuffle_assoc()

swapshuffle_assoc ( $array )

Like swapshuffle(), but works on associative arrays.

Parameters

array $array The associative array to be rearranged

Return values

array

◆ table_names()

table_names ( string $sql )

protected

Parse table names from query.

Parameters

string $sql

Return values

array

◆ tag_add()

tag_add ( )

Deprecated: since 3.1

◆ tag_assign()

tag_assign ( )

Deprecated: since 3.1. Use core_tag_tag\set_item_tags() or core_tag_tag\add_item_tag() instead

◆ tag_autocomplete()

tag_autocomplete ( )

Deprecated: since 3.0

◆ tag_bulk_delete_instances()

tag_bulk_delete_instances ( )

Deprecated: since 3.1

◆ tag_cleanup()

tag_cleanup ( )

Deprecated: since 3.1

◆ tag_cloud_sort()

tag_cloud_sort ( )

Deprecated: since 3.1

◆ tag_compute_correlations()

tag_compute_correlations ( )

Deprecated: since 3.1

◆ tag_cron()

tag_cron ( )

Deprecated: since 3.1

◆ tag_delete()

tag_delete ( )

Deprecated: since 3.1

◆ tag_delete_instance()

tag_delete_instance ( )

Deprecated: since 3.1. Use core_tag_tag\remove_item_tag() instead

◆ tag_delete_instances()

tag_delete_instances ( )

Deprecated: since 3.1

◆ tag_description_set()

tag_description_set ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->update() instead

◆ tag_display_name()

tag_display_name ( )

Deprecated: since 3.1

◆ tag_find_records()

tag_find_records ( )

Deprecated: since 3.1. Use core_tag_tag\get_by_name()->get_tagged_items() instead

◆ tag_find_tags()

tag_find_tags ( )

Deprecated: since 3.1

◆ tag_get()

tag_get ( )

Deprecated: since 3.1

◆ tag_get_correlated()

tag_get_correlated ( )

Deprecated: since 3.1

◆ tag_get_id()

tag_get_id ( )

Deprecated: since 3.1. Use core_tag_tag\get_by_name() or core_tag_tag\get_by_name_bulk()

◆ tag_get_name()

tag_get_name ( )

Deprecated: since 3.1

◆ tag_get_related_tags()

tag_get_related_tags ( )

Deprecated: since 3.1

◆ tag_get_related_tags_csv()

tag_get_related_tags_csv ( )

Deprecated: since 3.1

◆ tag_get_tags()

tag_get_tags ( )

Deprecated: since 3.1. Use core_tag_tag\get_item_tags() instead

◆ tag_get_tags_array()

tag_get_tags_array ( )

Deprecated: since 3.1

◆ tag_get_tags_csv()

tag_get_tags_csv ( )

Deprecated: since 3.1. Use core_tag_tag\get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag\get_item_tags())

◆ tag_get_tags_ids()

tag_get_tags_ids ( )

Deprecated: since 3.1. Use core_tag_tag\get_item_tags() instead

◆ tag_normalize()

tag_normalize ( )

Deprecated: since 3.1

◆ tag_print_cloud()

tag_print_cloud ( )

Deprecated: since 3.1

◆ tag_print_description_box()

tag_print_description_box ( )

Deprecated: since 3.1

◆ tag_print_management_box()

tag_print_management_box ( )

Deprecated: since 3.1

◆ tag_print_search_box()

tag_print_search_box ( )

Deprecated: since 3.1

◆ tag_print_search_results()

tag_print_search_results ( )

Deprecated: since 3.1

◆ tag_print_tagged_users_table()

tag_print_tagged_users_table ( )

Deprecated: since 3.1

◆ tag_print_user_box()

tag_print_user_box ( )

Deprecated: since 3.1

◆ tag_print_user_list()

tag_print_user_list ( )

Deprecated: since 3.1

◆ tag_process_computed_correlation()

tag_process_computed_correlation ( )

Deprecated: since 3.1

◆ tag_record_count()

tag_record_count ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->count_tagged_items() instead

◆ tag_record_tagged_with()

tag_record_tagged_with ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->is_item_tagged_with() instead

◆ tag_rename()

tag_rename ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->update() instead

◆ tag_set()

tag_set ( )

Deprecated: since 3.1

◆ tag_set_add()

tag_set_add ( )

Deprecated: since 3.1

◆ tag_set_delete()

tag_set_delete ( )

Deprecated: since 3.1

◆ tag_set_flag()

tag_set_flag ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->flag() instead

◆ tag_type_set()

tag_type_set ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->update() instead

◆ tag_unset_flag()

tag_unset_flag ( )

Deprecated: since 3.1. Use core_tag_tag\get($tagid)->reset_flag() instead

◆ testing_cli_argument_path()

testing_cli_argument_path ( $moodlepath )

Returns relative path against current working directory, to be used for shell execution hints.

Parameters

string $moodlepath starting with "/", ex: "/admin/tool/cli/init.php"

Return values

string path relative to current directory or absolute path

◆ testing_cli_fix_directory_separator()

testing_cli_fix_directory_separator ( $path )

Fix DIRECTORY_SEPARATOR for windows.

In PHP on Windows, DIRECTORY_SEPARATOR is set to the backslash (::) character. However, if you're running a Cygwin/Msys/Git shell exec() calls will return paths using the forward slash (/) character.

NOTE: Because PHP on Windows will accept either forward or backslashes, paths should be built using ONLY forward slashes, regardless of OS. MOODLE_DIRECTORY_SEPARATOR should only be used when parsing paths returned by the shell.

Parameters

string $path

Return values

string

◆ testing_error()

testing_error	(		$errorcode,
			$text = '' )

Prints an error and stops execution.

Parameters

integer	$errorcode
string	$text

Return values

void exits

◆ testing_fix_file_permissions()

testing_fix_file_permissions ( $file )

Try to change permissions to $CFG->dirroot or $CFG->dataroot if possible.

Parameters

string $file

Return values

bool success

◆ testing_initdataroot()

testing_initdataroot	(		$dataroot,
			$framework )

Mark empty dataroot to be used for testing.

Parameters

string	$dataroot	The dataroot directory
string	$framework	The test framework

Return values

void

◆ testing_is_cygwin()

testing_is_cygwin ( )

Find out if running under Cygwin on Windows.

Return values

bool

◆ testing_is_mingw()

testing_is_mingw ( )

Returns whether a mingw CLI is running.

MinGW sets $_SERVER['TERM'] to cygwin, but it can not run .bat files; this function may be useful when we need to output proposed commands to users using Windows CLI interfaces.

@externalurl http://sourceforge.net/p/mingw/bugs/1902

Return values

bool

◆ testing_update_composer_dependencies()

testing_update_composer_dependencies	(	bool	$selfupdate = true,
		bool	$updatedependencies = true )

Perform necessary steps to install and/or upgrade composer and its dependencies.

Installation is mandatory, but upgrade is optional.

Note: This function does not return, but will call exit() on error.

Parameters

bool	$selfupdate	Perform a composer self-update to update the composer.phar utility
bool	$updatedependencies	Upgrade dependencies

◆ text_filtering_hash() [1/2]

filter_manager::text_filtering_hash ( )

Deprecated: Since Moodle 3.0 MDL-50491. This was used by the old text filtering system, but no more.

◆ text_filtering_hash() [2/2]

null_filter_manager::text_filtering_hash ( )

As for the equivalent filter_manager method.

Deprecated: Since Moodle 3.0 MDL-50491.

◆ text_to_html()

text_to_html	(	$text,
		$smileyignored = null,
		$para = true,
		$newlines = true )

Given plain text, makes it into HTML as nicely as possible.

May contain HTML tags already.

Do not abuse this function. It is intended as lower level formatting feature used by format_text() to convert FORMAT_MOODLE to HTML. You are supposed to call format_text() in most of cases.

Parameters

string	$text	The string to convert.
boolean	$smileyignored	Was used to determine if smiley characters should convert to smiley images, ignored now
boolean	$para	If true then the returned string will be wrapped in div tags
boolean	$newlines	If true then lines newline breaks will be converted to HTML newline breaks.

Return values

string

◆ textlib_get_instance()

textlib_get_instance ( )

Deprecated: since Moodle 2.2 use core_text\xxxx() instead.

◆ theme_build_css_for_themes()

theme_build_css_for_themes	(	$themeconfigs = [],
		$directions = ['rtl', 'ltr'],
		$cache = true,
		$mtraceprogress = false )

Generates and saves the CSS files for the given theme configs.

Parameters

theme_config[]	$themeconfigs	An array of theme_config instances.
array	$directions	Must be a subset of ['rtl', 'ltr'].
bool	$cache	Should the generated files be stored in local cache.

Return values

array The built theme content in a multi-dimensional array of name => direction => content

◆ theme_get_config_file_path()

theme_get_config_file_path ( $themename )

Get the path to a theme config.php file.

Parameters

string $themename The non-frankenstyle name of the theme to check

◆ theme_get_css_filename()

theme_get_css_filename	(	$themename,
		$globalrevision,
		$themerevision,
		$direction )

Get the path to the local cached CSS file.

Parameters

string	$themename	The non-frankenstyle theme name.
int	$globalrevision	The global theme revision.
int	$themerevision	The theme specific revision.
string	$direction	Either 'ltr' or 'rtl' (case sensitive).

◆ theme_get_locked_theme_for_device()

theme_get_locked_theme_for_device ( $device )

Returns the theme named defined in config.php for the given device.

Return values

string or null

◆ theme_get_next_revision()

theme_get_next_revision ( )

Calculates and returns the next theme revision number.

Return values

int

◆ theme_get_next_sub_revision_for_theme()

theme_get_next_sub_revision_for_theme ( $themename )

Calculates and returns the next theme revision number.

Parameters

string $themename The non-frankenstyle name of the theme

Return values

int

◆ theme_get_revision()

theme_get_revision ( )

Returns current theme revision number.

Return values

int

◆ theme_get_sub_revision_for_theme()

theme_get_sub_revision_for_theme ( $themename )

Returns current theme sub revision number.

This is the revision for this theme exclusively, not the global theme revision.

Parameters

string $themename The non-frankenstyle name of the theme

Return values

int

◆ theme_is_device_locked()

theme_is_device_locked ( $device )

Checks if the given device has a theme defined in config.php.

Return values

bool

◆ theme_reset_all_caches()

theme_reset_all_caches ( )

Invalidate all server and client side caches.

This method deletes the physical directory that is used to cache the theme files used for serving. Because it deletes the main theme cache directory all themes are reset by this function.

◆ theme_reset_static_caches()

theme_reset_static_caches ( )

Reset static caches.

This method indicates that all running cron processes should exit at the next opportunity.

◆ theme_set_designer_mod()

theme_set_designer_mod ( $state )

Enable or disable theme designer mode.

Parameters

bool $state

◆ theme_set_revision()

theme_set_revision ( $revision )

Sets the current theme revision number.

Parameters

int $revision The new theme revision number

◆ theme_set_sub_revision_for_theme()

theme_set_sub_revision_for_theme	(		$themename,
			$revision )

Sets the current theme revision number for a specific theme.

This does not affect the global themerev value.

Parameters

string	$themename	The non-frankenstyle name of the theme
int	$revision	The new theme revision number

◆ truncate_userinfo()

truncate_userinfo ( array $info )

Will truncate userinfo as it comes from auth_get_userinfo (from external auth) which may have large fields.

Parameters

array $info Array of user properties to truncate if needed

Return values

array The now truncated information that was passed in

◆ trusttext_active()

trusttext_active ( )

Is trusttext feature active?

Return values

bool

◆ trusttext_pre_edit()

trusttext_pre_edit	(	$object,
		$field,
		$context )

Must be called before editing of all texts with trust flag.

Removes all XSS nasties from texts stored in database if needed.

Parameters

stdClass	$object	data object with xxx, xxxformat and xxxtrust fields
string	$field	name of text field
context	$context	active context

Return values

stdClass updated $object

◆ trusttext_trusted()

trusttext_trusted ( $context )

Is current user trusted to enter no dangerous XSS in this context?

Please note the user must be in fact trusted everywhere on this server!!

Parameters

context $context

Return values

bool	true if user trusted

◆ unformat_float()

unformat_float	(		$localefloat,
			$strict = false )

Converts locale specific floating point/comma number back to standard PHP float value Do NOT try to do any math operations before this conversion on any user submitted floats!

Parameters

string	$localefloat	locale aware float representation
bool	$strict	If true, then check the input and return false if it is not a valid number.

Return values

mixed float|bool - false or the parsed float.

◆ uninstall_plugin()

uninstall_plugin	(		$type,
			$name )

Automatically clean-up all plugin data and remove the plugin DB tables.

NOTE: do not call directly, use new /admin/plugins.php?uninstall=component instead!

Parameters

string	$type	The plugin type, eg. 'mod', 'qtype', 'workshopgrading' etc.
string	$name	The plugin name, eg. 'forum', 'multichoice', 'accumulative' etc. @uses global $OUTPUT to produce notices and other messages

Return values

void

◆ unload_all_filters() [1/2]

filter_manager::unload_all_filters ( )

protected

Unloads all filters and other cached information.

Reimplemented in performance_measuring_filter_manager.

◆ unload_all_filters() [2/2]

performance_measuring_filter_manager::unload_all_filters ( )

protected

Unloads all filters and other cached information.

Reimplemented from filter_manager.

◆ unserialize_array()

unserialize_array ( $expression )

Safe analogue of unserialize() that can only parse arrays.

Arrays may contain only integers or strings as both keys and values. Nested arrays are allowed.

Parameters

string $expression

Return values

array|bool either parsed array or false if parsing was impossible.

◆ unserialize_object()

unserialize_object ( string $input )

Safe method for unserializing given input that is expected to contain only a serialized instance of an stdClass object.

If any class type other than stdClass is included in the input string, it will not be instantiated and will be cast to an stdClass object. The initial cast to array, then back to object is to ensure we are always returning the correct type, otherwise we would return an instances of {

See also: __PHP_Incomplete_class} for malformed strings

Parameters

string $input

Return values

stdClass

◆ unset_all_config_for_plugin()

unset_all_config_for_plugin ( $plugin )

Remove all the config variables for a given plugin.

NOTE: this function is called from lib/db/upgrade.php

Parameters

string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';

Return values

boolean whether the operation succeeded.

◆ unset_cache_flag()

unset_cache_flag	(		$type,
			$name )

Removes a single volatile flag.

Parameters

string	$type	the "type" namespace for the key
string	$name	the key to set

Return values

bool

◆ unset_config()

unset_config	(		$name,
			$plugin = null )

Removes a key from global configuration.

NOTE: this function is called from lib/db/upgrade.php

Parameters

string	$name	the key to set
string	$plugin	(optional) the plugin scope

Return values

boolean whether the operation succeeded.

◆ unset_user_preference()

unset_user_preference	(		$name,
			$user = null )

Unsets a preference completely by deleting it from the database.

If a $user object is submitted it's 'preference' property is used for the preferences cache.

Parameters

string	$name	The key to unset as preference for the specified user
stdClass \| int \| null	$user	A moodle user object or id, null means current user

Exceptions

Return values

bool	Always true or exception

◆ unzip_file()

object unzip_file	(	$zipfile,
		$destination = '',
		$showstatus_ignored = true )

Unzip one zip file to a destination dir Both parameters must be FULL paths If destination isn't specified, it will be the SAME directory where the zip file resides.

Parameters

string	$zipfile	The zip file to unzip
string	$destination	The location to unzip to
bool	$showstatus_ignored	Unused

Deprecated: since 2.0 MDL-15919

◆ update_category_button()

update_category_button ( )

Deprecated: since 2.5

◆ update_event()

update_event ( )

Deprecated: please calendar_event->update() instead.

◆ update_field_with_unique_index()

update_field_with_unique_index	(		$table,
			$field,
		array	$newvalues,
		array	$otherconditions,
			$unusedvalue = -1 )

This method can update the values in mulitple database rows for a colum with a unique index, without violating that constraint.

Suppose we have a table with a unique index on (otherid, sortorder), and for a particular value of otherid, we want to change all the sort orders. You have to do this carefully or you will violate the unique index at some time. This method takes care of the details for you.

Note that, it is the responsibility of the caller to make sure that the requested rename is legal. For example, if you ask for [1 => 2, 2 => 2] then you will get a unique key violation error from the database.

Parameters

string	$table	The database table to modify.
string	$field	the field that contains the values we are going to change.
array	$newvalues	oldvalue => newvalue how to change the values. E.g. [1 => 4, 2 => 1, 3 => 3, 4 => 2].
array	$otherconditions	array fieldname => requestedvalue extra WHERE clause conditions to restrict which rows are affected. E.g. array('otherid' => 123).
int	$unusedvalue	(defaults to -1) a value that is never used in $ordercol.

◆ update_internal_user_password()

update_internal_user_password	(	$user,
		$password,
		$fasthash = false )

Update password hash in user object (if necessary).

The password is updated if:

The password has changed (the hash of $user->password is different to the hash of $password).
The existing hash is using an out-of-date algorithm (or the legacy md5 algorithm).

Updating the password will modify the $user object and the database record to use the current hashing algorithm. It will remove Web Services user tokens too.

Parameters

stdClass	$user	User object (password property may be updated).
string	$password	Plain text password.
bool	$fasthash	If true, use a low cost factor when generating the hash This is much faster to generate but makes the hash less secure. It is used when lots of hashes need to be generated quickly.

Return values

bool	Always returns true.

◆ update_log_display_entry()

update_log_display_entry ( )

Deprecated

◆ update_login_count()

update_login_count ( )

Deprecated

◆ update_module_button()

update_module_button ( )

Deprecated: since Moodle 3.2

◆ update_timezone_records()

update_timezone_records ( )

Deprecated: since Moodle 2.9

◆ update_user_login_times()

update_user_login_times ( )

Modify the user table by setting the currently logged in user's last login to now.

Return values

bool	Always returns true

◆ update_user_record()

update_user_record ( $username )

Will update a local user record from an external source (MNET users can not be updated using this method!).

Parameters

string $username user's username to update the record

Return values

stdClass A complete user object

◆ update_user_record_by_id()

update_user_record_by_id ( $id )

Will update a local user record from an external source (MNET users can not be updated using this method!).

Parameters

int $id user id

Return values

stdClass A complete user object

◆ upgrade_block_savepoint()

upgrade_block_savepoint	(	$result,
		$version,
		$blockname,
		$allowabort = true )

Blocks upgrade savepoint, marks end of blocks upgrade blocks It stores block version, resets upgrade timeout and abort upgrade if user cancels page loading.

Parameters

bool	$result	false if upgrade step failed, true if completed
	string	or float $version main version
string	$blockname	name of block
bool	$allowabort	allow user to abort script execution here

Return values

void

◆ upgrade_component_updated()

upgrade_component_updated	(	string	$component,
		string	$messageplug = '',
		bool	$coreinstall = false )

After upgrading a module, block, or generic plugin, various parts of the system need to be informed.

Parameters

string	$component	Frankenstyle component or 'moodle' for core
string	$messageplug	Set to the name of a message plugin if this is one
bool	$coreinstall	Set to true if this is the core install

◆ upgrade_core()

upgrade_core	(		$version,
			$verbose )

Upgrade moodle core.

Parameters

float	$version	target version
bool	$verbose

Return values

void,may throw exception

◆ upgrade_ensure_not_running()

upgrade_ensure_not_running ( $warningonly = false )

Makes sure that upgrade process is not running.

To be inserted in the core functions that can not be called by pluigns during upgrade. Core upgrade should not use any API functions at all. See

Exceptions

moodle_exception if executed from inside of upgrade script and $warningonly is false

Parameters

bool $warningonly if true displays a warning instead of throwing an exception

Return values

bool	true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only

◆ upgrade_finished()

object upgrade_finished ( $continueurl = null )

Indicates upgrade is finished.

This function may be called repeatedly.

@global object

◆ upgrade_install_plugins()

upgrade_install_plugins	(	array	$installable,
			$confirmed,
			$heading = '',
			$continue = null,
			$return = null )

Helper procedure/macro for installing remote plugins at admin/index.php.

Does not return, always redirects or exits.

Parameters

array	$installable	list of core\update\remote_info
bool	$confirmed	false: display the validation screen, true: proceed installation
string	$heading	validation screen heading
moodle_url \| string \| null	$continue	URL to proceed with installation at the validation screen
moodle_url \| string \| null	$return	URL to go back on cancelling at the validation screen

◆ upgrade_language_pack()

upgrade_language_pack ( $lang = null )

Try to upgrade the given language pack (or current language)

Parameters

string $lang the code of the language to update, defaults to the current language

◆ upgrade_log()

upgrade_log	(	$type,
		$plugin,
		$info,
		$details = null,
		$backtrace = null )

Adds log entry into upgrade_log table.

Parameters

int	$type	UPGRADE_LOG_NORMAL, UPGRADE_LOG_NOTICE or UPGRADE_LOG_ERROR
string	$plugin	frankenstyle component name
string	$info	short description text of log entry
string	$details	long problem description
string	$backtrace	string used for errors only

Return values

void

◆ upgrade_main_savepoint()

upgrade_main_savepoint	(	$result,
		$version,
		$allowabort = true )

Upgrade savepoint, marks end of each upgrade block.

It stores new main version, resets upgrade timeout and abort upgrade if user cancels page loading.

Please do not make large upgrade blocks with lots of operations, for example when adding tables keep only one table operation per block.

Parameters

bool	$result	false if upgrade step failed, true if completed
	string	or float $version main version
bool	$allowabort	allow user to abort script execution here

Return values

void

◆ upgrade_mod_savepoint()

upgrade_mod_savepoint	(	$result,
		$version,
		$modname,
		$allowabort = true )

Module upgrade savepoint, marks end of module upgrade blocks It stores module version, resets upgrade timeout and abort upgrade if user cancels page loading.

Parameters

bool	$result	false if upgrade step failed, true if completed
	string	or float $version main version
string	$modname	name of module
bool	$allowabort	allow user to abort script execution here

Return values

void

◆ upgrade_noncore()

upgrade_noncore ( $verbose )

Upgrade/install other parts of moodle.

Parameters

bool $verbose

Return values

void,may throw exception

◆ upgrade_plugin_mnet_functions()

upgrade_plugin_mnet_functions ( $component )

upgrades the mnet rpc definitions for the given component.

this method doesn't return status, an exception will be thrown in the case of an error

Parameters

string $component the plugin to upgrade, eg auth_mnet

◆ upgrade_plugin_savepoint()

upgrade_plugin_savepoint	(	$result,
		$version,
		$type,
		$plugin,
		$allowabort = true )

Plugins upgrade savepoint, marks end of blocks upgrade blocks It stores plugin version, resets upgrade timeout and abort upgrade if user cancels page loading.

Parameters

bool	$result	false if upgrade step failed, true if completed
	string	or float $version main version
string	$type	The type of the plugin.
string	$plugin	The name of the plugin.
bool	$allowabort	allow user to abort script execution here

Return values

void

◆ upgrade_plugins()

upgrade_plugins	(	$type,
		$startcallback,
		$endcallback,
		$verbose )

Upgrade plugins.

Parameters

string $type The type of plugins that should be updated (e.g. 'enrol', 'qtype') return void

◆ upgrade_plugins_blocks()

object upgrade_plugins_blocks	(	$startcallback,
		$endcallback,
		$verbose )

This function finds all available blocks and install them into blocks table or do all the upgrade process if newer.

@global object

◆ upgrade_plugins_modules()

object upgrade_plugins_modules	(	$startcallback,
		$endcallback,
		$verbose )

Find and check all modules and load them up or upgrade them if necessary.

@global object

◆ upgrade_set_timeout()

upgrade_set_timeout ( $max_execution_time = 300 )

Sets maximum expected time needed for upgrade task.

Please always make sure that upgrade will not run longer!

The script may be automatically aborted if upgrade times out.

Parameters

int $max_execution_time in seconds (can not be less than 60 s)

◆ upgrade_stale_php_files_present()

upgrade_stale_php_files_present ( )

Detect if there are leftovers in PHP source files.

During main version upgrades administrators MUST move away old PHP source files and start from scratch (or better use git).

Return values

bool	true means borked upgrade, false means previous PHP files were properly removed

◆ upgrade_started()

object upgrade_started ( $preinstall = false )

Marks start of upgrade, blocks any other access to site.

The upgrade is finished at the end of script or after timeout.

@global object @global object

◆ user_accesstime_log()

stdClass user_accesstime_log ( $courseid = 0 )

Store user last access times - called when use enters a course or site.

$USER @global stdClass $CFG @global moodle_database $DB @uses LASTACCESS_UPDATE_SECS @uses SITEID

Parameters

int $courseid empty courseid means site

Return values

void

◆ user_can_create_courses()

object user_can_create_courses ( )

@uses CONTEXT_COURSECAT

Return values

boolean Whether the user can create courses in any category in the system.

◆ user_get_participants()

user_get_participants	(	$courseid,
		$groupid,
		$accesssince,
		$roleid,
		$enrolid,
		$statusid,
		$search,
		$additionalwhere = '',
		$additionalparams = array(),
		$sort = '',
		$limitfrom = 0,
		$limitnum = 0 )

Returns the participants for a given course.

Deprecated: since Moodle 3.9 MDL-68612 - See core_user\table\participants_search for an improved way to fetch participants.

Parameters

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

Return values

moodle_recordset

◆ user_get_participants_sql()

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

Returns the SQL used by the participants table.

Deprecated: since Moodle 3.9 MDL-68612 - See core_user\table\participants_search for an improved way to fetch participants.

Parameters

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

Return values

array

◆ user_get_total_participants()

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

Returns the total number of participants for a given course.

Deprecated: since Moodle 3.9 MDL-68612 - See core_user\table\participants_search for an improved way to fetch participants.

Parameters

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

Return values

int

◆ user_not_fully_set_up()

user_not_fully_set_up	(		$user,
			$strict = true )

Determines if a user has completed setting up their account.

The lax mode (with $strict = false) has been introduced for special cases only where we want to skip certain checks intentionally. This is valid in certain mnet or ajax scenarios when the user cannot / should not be redirected to edit their profile. In most cases, you should perform the strict check.

Parameters

stdClass	$user	A $USER object to test for the existence of a valid name and email
bool	$strict	Be more strict and assert id and custom profile fields set, too

Return values

bool

◆ user_preference_allow_ajax_update()

user_preference_allow_ajax_update	(		$name,
			$paramtype )

You need to call this function if you wish to use the set_user_preference method in javascript_static.php, to white-list the preference you want to update from JavaScript, and to specify the type of cleaning you expect to be done on values.

Parameters

string	$name	the name of the user_perference we should allow to be updated by remote calls.
integer	$paramtype	one of the PARAM_{TYPE} constants, user to clean submitted values before set_user_preference is called.

Return values

null

◆ userdate()

userdate	(	$date,
		$format = '',
		$timezone = 99,
		$fixday = true,
		$fixhour = true )

Returns a formatted string that represents a date in user time.

Parameters

int	$date	the timestamp in UTC, as obtained from the database.
string	$format	strftime format. You should probably get this using get_string('strftime...', 'langconfig');
int \| float \| string	$timezone	by default, uses the user's time zone. if numeric and not 99 then daylight saving will not be added.
bool	$fixday	If true (default) then the leading zero from d is removed. If false then the leading zero is maintained.
bool	$fixhour	If true (default) then the leading zero from I is removed.

Return values

string the formatted date/time.

◆ userdate_htmltime()

userdate_htmltime	(	$date,
		$format = '',
		$timezone = 99,
		$fixday = true,
		$fixhour = true )

Returns a html "time" tag with both the exact user date with timezone information as a datetime attribute in the W3C format, and the user readable date and time as text.

Parameters

int	$date	the timestamp in UTC, as obtained from the database.
string	$format	strftime format. You should probably get this using get_string('strftime...', 'langconfig');
int \| float \| string	$timezone	by default, uses the user's time zone. if numeric and not 99 then daylight saving will not be added.
bool	$fixday	If true (default) then the leading zero from d is removed. If false then the leading zero is maintained.
bool	$fixhour	If true (default) then the leading zero from I is removed.

Return values

string the formatted date/time.

◆ useredit_shared_definition_preferences()

useredit_shared_definition_preferences ( )

Deprecated: since Moodle 2.9 MDL-45774 - Please do not use this function any more.

◆ usergetdate()

usergetdate	(		$time,
			$timezone = 99 )

Given a $time timestamp in GMT (seconds since epoch), returns an array that represents the Gregorian date in user time.

Parameters

int	$time	Timestamp in GMT
float \| int \| string	$timezone	user timezone

Return values

array An array that represents the date in user time

◆ usergetmidnight()

usergetmidnight	(		$date,
			$timezone = 99 )

Given a time, return the GMT timestamp of the most recent midnight for the current user.

Parameters

int	$date	Timestamp in GMT
float \| int \| string	$timezone	user timezone

Return values

int	Returns a GMT timestamp

◆ username_load_fields_from_object()

username_load_fields_from_object	(	$addtoobject,
		$secondobject,
		$prefix = null,
		$additionalfields = null )

Reduces lines of duplicated code for getting user name fields.

◆ users_order_by_sql()

users_order_by_sql	(	string	$usertablealias = '',
		string	$search = null,
		context	$context = null,
		array	$customfieldmappings = [] )

This function generates the standard ORDER BY clause for use when generating lists of users.

If you don't have a reason to use a different order, then you should use this method to generate the order when displaying lists of users.

If the optional $search parameter is passed, then exact matches to the search will be sorted first. For example, suppose you have two users 'Al Zebra' and 'Alan Aardvark'. The default sort is Alan, then Al. If, however, you search for 'Al', then Al will be listed first. (With two users, this is not a big deal, but with thousands of users, it is essential.)

The list of fields scanned for exact matches are:

firstname
lastname
$DB->sql_fullname
those returned by core_user\fields\get_identity_fields or those included in $customfieldmappings

If named parameters are used (which is the default, and highly recommended), then the parameter names are like :usersortexactN, where N is an int.

The simplest possible example use is: list($sort, $params) = users_order_by_sql(); $sql = 'SELECT * FROM {users} ORDER BY ' . $sort;

A more complex example, showing that this sort can be combined with other sorts: list($sort, $sortparams) = users_order_by_sql('u'); $sql = "SELECT g.id AS groupid, gg.groupingid, u.id AS userid, u.firstname, u.lastname, u.idnumber, u.username FROM {groups} g LEFT JOIN {groupings_groups} gg ON g.id = gg.groupid LEFT JOIN {groups_members} gm ON g.id = gm.groupid LEFT JOIN {user} u ON gm.userid = u.id WHERE g.courseid = :courseid $groupwhere $groupingwhere ORDER BY g.name, $sort"; $params += $sortparams;

An example showing the use of $search: list($sort, $sortparams) = users_order_by_sql('u', $search, $this->get_context()); $order = ' ORDER BY ' . $sort; $params += $sortparams; $availableusers = $DB->get_records_sql($fields . $sql . $order, $params, $page*$perpage, $perpage);

Parameters

string	$usertablealias	(optional) any table prefix for the {users} table. E.g. 'u'.
string	$search	(optional) a current search string. If given, any exact matches to this string will be sorted first.
context \| null	$context	the context we are in. Used by core_user\fields\get_identity_fields. Defaults to $PAGE->context.
array	$customfieldmappings	associative array of mappings for custom fields returned by core_user\fields\get_sql.

Return values

array with two elements: string SQL fragment to use in the ORDER BY clause. For example, "firstname, lastname". array of parameters used in the SQL fragment. If $search is not given, this is guaranteed to be an empty array.

◆ users_search_sql()

users_search_sql	(	string	$search,
		string	$u = 'u',
		bool	$searchanywhere = true,
		array	$extrafields = [],
		array	$exclude = null,
		array	$includeonly = null )

Returns SQL used to search through user table to find users (in a query which may also join and apply other conditions).

You can combine this SQL with an existing query by adding 'AND $sql' to the WHERE clause of your query (where $sql is the first element in the array returned by this function), and merging in the $params array to the parameters of your query (where $params is the second element). Your query should use named parameters such as :param, rather than the question mark style.

There are examples of basic usage in the unit test for this function.

Parameters

string	$search	the text to search for (empty string = find all)
string	$u	the table alias for the user table in the query being built. May be ''.
bool	$searchanywhere	If true (default), searches in the middle of names, otherwise only searches at start
array	$extrafields	Array of extra user fields to include in search, must be prefixed with table alias if they are not in the user table.
array	$exclude	Array of user ids to exclude (empty = don't exclude)
array	$includeonly	If specified, only returns users that have ids incldued in this array (empty = don't restrict)

Return values

array an array with two elements, a fragment of SQL to go in the where clause the query, and an associative array containing any required parameters (using named placeholders).

◆ usertime()

usertime	(		$date,
			$timezone = 99 )

Given a GMT timestamp (seconds since epoch), offsets it by the timezone.

eg 3pm in India is 3pm GMT - 7 * 3600 seconds

NOTE: this function does not include DST properly, you should use the PHP date stuff instead!

Parameters

int	$date	Timestamp in GMT
float \| int \| string	$timezone	user timezone

Return values

int

◆ usertimezone()

usertimezone ( $timezone = 99 )

Returns a string that prints the user's timezone.

Parameters

float | int | string $timezone user timezone

Return values

string

◆ valid_uploaded_file()

valid_uploaded_file ( $newfile )

Returns current name of file on disk if it exists.

Parameters

string $newfile File to be verified

Return values

string Current name of file on disk if true

◆ validate_email()

validate_email ( $address )

Validates an email to make sure it makes sense.

Parameters

string $address The email address to validate.

Return values

boolean

◆ validate_internal_user_password()

validate_internal_user_password	(		$user,
			$password )

Compare password against hash stored in user object to determine if it is valid.

If necessary it also updates the stored hash to the current format.

Parameters

stdClass	$user	(Password property may be updated).
string	$password	Plain text password.

Return values

bool	True if password is valid.

◆ validate_param()

validate_param	(	$param,
		$type,
		$allownull = NULL_NOT_ALLOWED,
		$debuginfo = '' )

Strict validation of parameter values, the values are only converted to requested PHP type.

Internally it is using clean_param, the values before and after cleaning must be equal - otherwise an invalid_parameter_exception is thrown. Objects and classes are not accepted.

Parameters

mixed	$param
string	$type	PARAM_ constant
bool	$allownull	are nulls valid value?
string	$debuginfo	optional debug information

Return values

mixed the $param value converted to PHP type

Exceptions

invalid_parameter_exception if $param is not of given type

◆ validate_user_key()

validate_user_key	(	$keyvalue,
		$script,
		$instance )

Validates a user key, checking if the key exists, is not expired and the remote ip is correct.

Parameters

string	$keyvalue	the key value
string	$script	unique script identifier
int	$instance	instance id

Return values

stdClass the key entry in the user_private_key table

Since: Moodle 3.2

Exceptions