Preference API

Revision as of 08:26, 12 January 2012 by Gerard Caulfield (talk | contribs) (get_user_preferences($name = null, $default = null, $user = null))

Jump to: navigation, search

Moodle 2.0

WORK IN PROGRESS: I've currently just created a template, so please ignore this page until this wip notices has been removed. However, you are free to help in the construction of this page by improving it. Please review the tion=history edit history if you would like to contact the user who put up this notice. If this article has not been edited by that user in a while, please remove this template.

Preference API database table

Field Type Default Info
id unsigned int(10) auto-incrementing The unique ID for this preference.
userid unsigned int(10) The user that the preference belongs to
name varchar(255) The name of the preference
value varchar(255) The value of the preference

Preference API 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.

get_user_preferences($name = null, $default = null, $user = null)

This function can be used to fetch the value of a given 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.

set_user_preference($name, $value, $user = null)

Example function description.

set_user_preferences(array $prefarray, $user = null)

Example function description.

unset_user_preference($name, $user = null)

Example function description.

set_user_preference($name, $value, $user = null)

Example function description.

Preference API Usage

Title for the example goes here

Description of the example:


See also