Hierarchy

  • ReturnsItem

Properties

address: null | string

Postal address

city: null | string

Home city of the user

country: null | string

Home country code of the user, such as AU or CZ

User custom fields (also known as user profil fields)

department: null | string

department

description: null | string

User profile description

descriptionformat: null | number

description format (1 = HTML, 0 = MOODLE, 2 = PLAIN, or 4 = MARKDOWN

email: null | string

An email address - allow email as root@localhost

Courses where the user is enrolled - limited by which courses the user is able to see

firstaccess: null | number

first access to the site (0 if never)

firstname: null | string

The first name(s) of the user

fullname: null | string

The fullname of the user

user groups

id: null | number

ID of the user

idnumber: null | string

An arbitrary ID code number perhaps from the institution

institution: null | string

institution

interests: null | string

user interests (separated by commas)

lastaccess: null | number

last access to the site (0 if never)

lastcourseaccess: null | number

last access to the course (0 if never)

lastname: null | string

The family name of the user

phone1: null | string

Phone 1

phone2: null | string

Phone 2

User preferences

profileimageurl: null | string

User image profile URL - big version

profileimageurlsmall: null | string

User image profile URL - small version

user roles

username: null | string

Username policy is defined in Moodle security config

Generated using TypeDoc