Preference API - Revision history

Devdocsbot: Protected "Preference API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-24T14:06:44Z

Protected "Preference API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 14:06, 24 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-24T14:04:18Z

Update migration status and path

← Older revision		Revision as of 14:04, 24 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/core/preference/}}
	{{Moodle 2.0}}		{{Moodle 2.0}}
	==Overview==		==Overview==

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:23:30Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:23, 14 July 2021
Line 55:		Line 55:
	)		)
	*/		*/
	</~~code~~>		</syntaxhighlight>

	==Preference API database table==		==Preference API database table==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:30:37Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 22:
Line 22:
===Example usage=== ===Example usage===



<code php> <syntaxhighlight lang="php">
// Set a preference and then retrieve it // Set a preference and then retrieve it
set_user_preference('foo_nameformat', 'long'); set_user_preference('foo_nameformat', 'long');



Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""
2021-07-14T13:22:23Z
Text replacement - "class="nicetable"" to "class="wikitable""

				
				
				
				
				
				← Older revision
				Revision as of 13:22, 14 July 2021
				
Line 61:
Line 61:
Note: This shows the schema for Moodle 2.2, earlier version had smaller limits on some of the fields. If you are not using Moodle 2.2, then please refer to whatever database administration tool you may be using. Note: This shows the schema for Moodle 2.2, earlier version had smaller limits on some of the fields. If you are not using Moodle 2.2, then please refer to whatever database administration tool you may be using.



{| class="nicetable" {| class="wikitable"
|- |-
! Field ! Field



Gerrywastaken at 05:52, 8 February 2012
2012-02-08T05:52:56Z


				
				
				
				
				
				← Older revision
				Revision as of 05:52, 8 February 2012
				
Line 1:
Line 1:
{{Moodle 2.0}} {{Moodle 2.0}}
==Preference API overview== ==Overview==



The Preference API has been implemented in lib/moodlelib.php. It's used for the storage and retrieval of user preferences. These preferences are stored in the database for users with an account, however for guests or people who are not logged in the preferences are stored in a PHP Session. All of these functions operate on the current user by default, however you can specify the user you wish to operate on by passing a user ID or a moodle user object to the $user parameter. Normally this is used for state indicators, where it can be as simple as a yes or no, however you can also use it to store more complex user data, such as a serialized PHP object. The Preference API has been implemented in lib/moodlelib.php. It's used for the storage and retrieval of user preferences. These preferences are stored in the database for users with an account, however for guests or people who are not logged in the preferences are stored in a PHP Session. All of these functions operate on the current user by default, however you can specify the user you wish to operate on by passing a user ID or a moodle user object to the $user parameter. Normally this is used for state indicators, where it can be as simple as a yes or no, however you can also use it to store more complex user data, such as a serialized PHP object.



Dougiamas at 08:58, 25 January 2012
2012-01-25T08:58:37Z


				
				
				
				
				
				← Older revision
				Revision as of 08:58, 25 January 2012
				
Line 90:
Line 90:



==See also== ==See also==

* [[Core APIs]]

[[Category:API]]



Gerrywastaken: adding back mistakenly removed function name
2012-01-23T06:32:48Z
adding back mistakenly removed function name

				
				
				
				
				
				← Older revision
				Revision as of 06:32, 23 January 2012
				
Line 6:
Line 6:
It is considered good practice to abstain from storing default values as a user preference as this creates a lot of redundancy. Instead you should apply the default value at the code level if there is no stored value for a given preference. It is considered good practice to abstain from storing default values as a user preference as this creates a lot of redundancy. Instead you should apply the default value at the code level if there is no stored value for a given preference.



====($name = null, $default = null, $user = null)==== ====get_user_preferences($name = null, $default = null, $user = null)====
This function can be used to fetch the value of a requested (via $name) preference, or if it doesn't exist the value given in the $default parameter will be returned. If you do not specify a $name then all preferences will be returned. This function can be used to fetch the value of a requested (via $name) preference, or if it doesn't exist the value given in the $default parameter will be returned. If you do not specify a $name then all preferences will be returned.






Gerrywastaken: Updating table structure to Moodle 2.2 schema
2012-01-23T02:21:15Z
Updating table structure to Moodle 2.2 schema

				
				
				
				
				
				← Older revision
				Revision as of 02:21, 23 January 2012
				
Line 58:
Line 58:



==Preference API database table== ==Preference API database table==

Note: This shows the schema for Moodle 2.2, earlier version had smaller limits on some of the fields. If you are not using Moodle 2.2, then please refer to whatever database administration tool you may be using.



{| class="nicetable" {| class="nicetable"



Gerrywastaken: /* Preference API database table */
2012-01-23T02:16:22Z
Preference API database table

				
				
				
				
				
				← Older revision
				Revision as of 02:16, 23 January 2012
				
Line 82:
Line 82:
|- |-
| value | value
| varchar(255) | varchar(1333)
| |
| The value of the preference | The value of the preference

← Older revision		Revision as of 13:30, 14 July 2021
Line 22:		Line 22:
	===Example usage===		===Example usage===

	<~~code~~ php>		<syntaxhighlight lang="php">
	// Set a preference and then retrieve it		// Set a preference and then retrieve it
	set_user_preference('foo_nameformat', 'long');		set_user_preference('foo_nameformat', 'long');

← Older revision		Revision as of 13:22, 14 July 2021
Line 61:		Line 61:
	Note: This shows the schema for Moodle 2.2, earlier version had smaller limits on some of the fields. If you are not using Moodle 2.2, then please refer to whatever database administration tool you may be using.		Note: This shows the schema for Moodle 2.2, earlier version had smaller limits on some of the fields. If you are not using Moodle 2.2, then please refer to whatever database administration tool you may be using.

	{\| class="~~nicetable~~"		{\| class="wikitable"
	\|-		\|-
	! Field		! Field

← Older revision		Revision as of 05:52, 8 February 2012
Line 1:		Line 1:
	{{Moodle 2.0}}		{{Moodle 2.0}}
	==~~Preference API overview~~==		==Overview==

	The Preference API has been implemented in lib/moodlelib.php. It's used for the storage and retrieval of user preferences. These preferences are stored in the database for users with an account, however for guests or people who are not logged in the preferences are stored in a PHP Session. All of these functions operate on the current user by default, however you can specify the user you wish to operate on by passing a user ID or a moodle user object to the $user parameter. Normally this is used for state indicators, where it can be as simple as a yes or no, however you can also use it to store more complex user data, such as a serialized PHP object.		The Preference API has been implemented in lib/moodlelib.php. It's used for the storage and retrieval of user preferences. These preferences are stored in the database for users with an account, however for guests or people who are not logged in the preferences are stored in a PHP Session. All of these functions operate on the current user by default, however you can specify the user you wish to operate on by passing a user ID or a moodle user object to the $user parameter. Normally this is used for state indicators, where it can be as simple as a yes or no, however you can also use it to store more complex user data, such as a serialized PHP object.

← Older revision		Revision as of 08:58, 25 January 2012
Line 90:		Line 90:

	==See also==		==See also==

			* [[Core APIs]]

			[[Category:API]]

← Older revision		Revision as of 06:32, 23 January 2012
Line 6:		Line 6:
	It is considered good practice to abstain from storing default values as a user preference as this creates a lot of redundancy. Instead you should apply the default value at the code level if there is no stored value for a given preference.		It is considered good practice to abstain from storing default values as a user preference as this creates a lot of redundancy. Instead you should apply the default value at the code level if there is no stored value for a given preference.

	====($name = null, $default = null, $user = null)====		====get_user_preferences($name = null, $default = null, $user = null)====
	This function can be used to fetch the value of a requested (via $name) preference, or if it doesn't exist the value given in the $default parameter will be returned. If you do not specify a $name then all preferences will be returned.		This function can be used to fetch the value of a requested (via $name) preference, or if it doesn't exist the value given in the $default parameter will be returned. If you do not specify a $name then all preferences will be returned.

← Older revision		Revision as of 02:21, 23 January 2012
Line 58:		Line 58:

	==Preference API database table==		==Preference API database table==

			Note: This shows the schema for Moodle 2.2, earlier version had smaller limits on some of the fields. If you are not using Moodle 2.2, then please refer to whatever database administration tool you may be using.

	{\| class="nicetable"		{\| class="nicetable"

← Older revision		Revision as of 02:16, 23 January 2012
Line 82:		Line 82:
	\|-		\|-
	\| value		\| value
	\| varchar(~~255~~)		\| varchar(1333)
	\|		\|
	\| The value of the preference		\| The value of the preference