Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

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

[Source view]

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

Auth e-mail external API

Copyright: 2016 Juan Leyva <juan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 373 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

auth_email_external:: (7 methods):
  check_signup_enabled()
  get_signup_settings_parameters()
  get_signup_settings()
  get_signup_settings_returns()
  signup_user_parameters()
  signup_user()
  signup_user_returns()


Class: auth_email_external  - X-Ref

Auth e-mail external functions

check_signup_enabled()   X-Ref
Check if registration is enabled in this site.


get_signup_settings_parameters()   X-Ref
Describes the parameters for get_signup_settings.

return: external_function_parameters

get_signup_settings()   X-Ref
Get the signup required settings and profile fields.

return: array settings and possible warnings

get_signup_settings_returns()   X-Ref
Describes the get_signup_settings return value.

return: external_single_structure

signup_user_parameters()   X-Ref
Describes the parameters for signup_user.

return: external_function_parameters

signup_user($username, $password, $firstname, $lastname, $email, $city = '', $country = '',$recaptchachallengehash = '', $recaptcharesponse = '', $customprofilefields = array()   X-Ref
Get the signup required settings and profile fields.

param: string $username               username
param: string $password               plain text password
param: string $firstname              the first name(s) of the user
param: string $lastname               the family name of the user
param: string $email                  a valid and unique email address
param: string $city                   home city of the user
param: string $country                home country code
param: string $recaptchachallengehash recaptcha challenge hash
param: string $recaptcharesponse      recaptcha response
param: array  $customprofilefields    user custom fields (also known as user profile fields)
param: string $redirect               Site url to redirect the user after confirmation
return: array settings and possible warnings

signup_user_returns()   X-Ref
Describes the signup_user return value.

return: external_single_structure