User profile fields - Revision history

Systemovich: /* define_validate_specific() */ Added full stop.

2021-03-26T09:44:07Z

define_validate_specific(): Added full stop.

← Older revision		Revision as of 09:44, 26 March 2021
Line 37:		Line 37:

	====define_validate_specific()====		====define_validate_specific()====
	Validate the data from the add/edit profile field form that is specific to the current data type		Validate the data from the add/edit profile field form that is specific to the current data type.
	<pre>		<pre>
	function define_validate_specific($data) {		function define_validate_specific($data) {
Line 48:		Line 48:
	}		}
	</pre>		</pre>

	====define_after_data====		====define_after_data====
	Alter form based on submitted or existing data		Alter form based on submitted or existing data

Systemovich: /* define_form_specific() */ Added full stop.

2021-03-26T09:43:44Z

define_form_specific(): Added full stop.

← Older revision		Revision as of 09:43, 26 March 2021
Line 26:		Line 26:
	===define.class.php===		===define.class.php===
	====define_form_specific()====		====define_form_specific()====
	Prints out the form snippet for the part of creating or editing a profile field specific to the current data type		Prints out the form snippet for the part of creating or editing a profile field specific to the current data type.
	<pre>		<pre>
	function define_form_specific(&$form) {		function define_form_specific(&$form) {
Line 35:		Line 35:
	}		}
	</pre>		</pre>

	====define_validate_specific()====		====define_validate_specific()====
	Validate the data from the add/edit profile field form that is specific to the current data type		Validate the data from the add/edit profile field form that is specific to the current data type

Systemovich: /* Naming convention */ Emphasised file names. Made the sentences easier to understand.

2021-03-26T09:40:39Z

Naming convention: Emphasised file names. Made the sentences easier to understand.

← Older revision		Revision as of 09:40, 26 March 2021
Line 18:		Line 18:

	==Naming convention==		==Naming convention==
	# '''profilefield_''' is prefixed to name of user profile field plugin, for identifying the name of the plugin.		# '''profilefield_''' is prefixed to the name of the user profile field plugin, for identifying the name of the plugin.
	# define.class.php should ~~have~~ a class with '''profile_define_''' ~~prefix~~ to custom user profile field plugin name.		# ''define.class.php'' should contain a class with a name that has '''profile_define_''' prefixed to the custom user profile field plugin name.
	# field.class.php should ~~have~~ a class with '''profile_field_''' ~~prefix~~ to custom user profile field plugin name.		# ''field.class.php'' should contain a class with a name that has '''profile_field_''' prefixed to the custom user profile field plugin name.
	# ~~Language~~ file should define '''pluginname''' as name of the plugin.		# The language file should define a '''pluginname''' string as the name of the plugin.

	==Interface API==		==Interface API==
	===define.class.php===		===define.class.php===

Systemovich: /* File Structure */ Fixed grammar. Made capitalization consistent. Emphasized file names.

2021-03-26T09:35:04Z

File Structure: Fixed grammar. Made capitalization consistent. Emphasized file names.

← Older revision		Revision as of 09:35, 26 March 2021
Line 10:		Line 10:

	==File Structure==		==File Structure==
	# Create a folder for your plugin in ~~moodle~~/user/profile/field/customprofilefieldplugin. The folder name should contain only letters and numbers.		# Create a folder for your plugin in ''/user/profile/field/customprofilefieldplugin''. The folder name should contain only letters and numbers.
	# Create following files and add them to customprofilefieldplugin		# Create the following files and add them to customprofilefieldplugin:
	## lang/en/profilefield_customprofilefieldplugin.php - Language file, containing strings for user profile field.		## ''lang/en/profilefield_customprofilefieldplugin.php'' - Language file, containing strings for user profile field.
	## define.class.php - ~~definition~~ of user profile field will be added in this file.		## ''define.class.php'' - Definition of the user profile field type will be added in this file.
	## field.class.php - Controls user profile field display, while editing or showing as user profile field.		## ''field.class.php'' - Controls user profile field display, while editing or showing as user profile field.
	## version.php - ~~contains~~ version information for customprofilefieldplugin		## ''version.php'' - Contains version information for customprofilefieldplugin.

	==Naming convention==		==Naming convention==

Systemovich: /* File Structure */ Added missing full stop. Underscores in the folder name will be stripped out, but then the folder will not be found.

2021-03-26T09:30:01Z

File Structure: Added missing full stop. Underscores in the folder name will be stripped out, but then the folder will not be found.

← Older revision		Revision as of 09:30, 26 March 2021
Line 10:		Line 10:

	==File Structure==		==File Structure==
	# Create a folder for your plugin in moodle/user/profile/field/customprofilefieldplugin		# Create a folder for your plugin in moodle/user/profile/field/customprofilefieldplugin. The folder name should contain only letters and numbers.
	# Create following files and add them to customprofilefieldplugin		# Create following files and add them to customprofilefieldplugin
	## lang/en/profilefield_customprofilefieldplugin.php - Language file, containing strings for user profile field.		## lang/en/profilefield_customprofilefieldplugin.php - Language file, containing strings for user profile field.
Line 16:		Line 16:
	## field.class.php - Controls user profile field display, while editing or showing as user profile field.		## field.class.php - Controls user profile field display, while editing or showing as user profile field.
	## version.php - contains version information for customprofilefieldplugin		## version.php - contains version information for customprofilefieldplugin

	==Naming convention==		==Naming convention==
	# '''profilefield_''' is prefixed to name of user profile field plugin, for identifying the name of the plugin.		# '''profilefield_''' is prefixed to name of user profile field plugin, for identifying the name of the plugin.

Systemovich: /* History */ Fix grammar and make capitalization consistent in list of profile field plug-ins.

2021-03-26T09:27:38Z

History: Fix grammar and make capitalization consistent in list of profile field plug-ins.

← Older revision		Revision as of 09:27, 26 March 2021
Line 2:		Line 2:
	This plugin allows you to add custom user profile field types of which instances can be added to the user profile. For example, if you want to display radio buttons on the user profile, then create a radio user profile field plugin, then create an instance of it.		This plugin allows you to add custom user profile field types of which instances can be added to the user profile. For example, if you want to display radio buttons on the user profile, then create a radio user profile field plugin, then create an instance of it.
	==History==		==History==
	User profile fields ~~exists~~ from 1.9 and ~~supports~~ five default user profile field plugins:		User profile fields exist from Moodle 1.9 and support five default user profile field plugins:
	# ~~Checkbox~~		# checkbox
	# datetime		# datetime
	# menu		# menu
	# text		# text
	# textarea		# textarea

	==File Structure==		==File Structure==
	# Create a folder for your plugin in moodle/user/profile/field/customprofilefieldplugin		# Create a folder for your plugin in moodle/user/profile/field/customprofilefieldplugin

Systemovich: Improve grammar of introduction paragraph.

2021-03-26T09:25:14Z

Improve grammar of introduction paragraph.

← Older revision		Revision as of 09:25, 26 March 2021
Line 1:		Line 1:
	==Introduction==		==Introduction==
	This plugin ~~allow~~ you to add custom user profile ~~fields,~~ which can be added to user profile. For example, if you want to display radio buttons on user profile, then create radio user profile field plugin ~~and add them to user profile field~~.		This plugin allows you to add custom user profile field types of which instances can be added to the user profile. For example, if you want to display radio buttons on the user profile, then create a radio user profile field plugin, then create an instance of it.
	==History==		==History==
	User profile fields exists from 1.9 and supports five default user profile field plugins:		User profile fields exists from 1.9 and supports five default user profile field plugins:

Eizeddin: /* edit_validate_field() */ (return $errors[$this->inputname] = 'error';) returns string 'error' not array!

2016-02-13T17:34:34Z

edit_validate_field(): (return $errors[$this->inputname] = 'error';) returns string 'error' not array!

← Older revision		Revision as of 17:34, 13 February 2016
Line 105:		Line 105:
	if (isset($usernew->{$this->inputname})) {		if (isset($usernew->{$this->inputname})) {
	if ($usernew->{$this->inputname}['text'] === '') {		if ($usernew->{$this->inputname}['text'] === '') {
	~~return~~ $errors[$this->inputname] = 'error';		$errors[$this->inputname] = 'error';
	}		}
	}		}
			return $errors;
	}		}
	</pre>		</pre>

	====edit_save_data_preprocess()====		====edit_save_data_preprocess()====
	Process the data before it gets saved in database		Process the data before it gets saved in database

Liamhanks: added mention of including ...user/profile/lib.php before calling the profile_ functions.

2013-04-11T19:26:55Z

added mention of including ...user/profile/lib.php before calling the profile_ functions.

← Older revision		Revision as of 19:26, 11 April 2013
Line 135:		Line 135:
	</pre>		</pre>
	===Common functions===		===Common functions===
			The following will need to be added to any files accessing the profile_ functions:
			<pre>
			require_once("$CFG->dirroot/user/profile/lib.php");
			</pre>
	====profile_user_record($userid)====		====profile_user_record($userid)====
	Returns an object with the custom profile fields set for the given user		Returns an object with the custom profile fields set for the given user

Dougiamas: /* Which form elements does moodle support */

2012-01-30T06:33:48Z

Which form elements does moodle support

← Older revision		Revision as of 06:33, 30 January 2012
Line 153:		Line 153:
	===Which form elements does moodle support===		===Which form elements does moodle support===
	Refer [[Form_API]] for list of elements supported by moodle		Refer [[Form_API]] for list of elements supported by moodle




			[[Category:Plugins]]