NEWMODULE Reference

Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.

This is a first draft of the list of functions frequently used in Moodle modules. The number of occurrences of each function in the following list of 20 modules is found in parenthesis: assignment, chat, choice, data, exercise, feedback, forum, glossary, hotpot, journal, label, lams, lesson, questionnaire, quiz, resource, scorm, survey, wiki, workshop.

newmodule_add_instance (20)

Create a new newmodule activity

Given an object containing all the necessary data (defined by the form in mod.html), this function will create a new instance and return the id number of the new instance. The due date is added to the calendar. This is common to all assignment types.

newmodule_delete_instance (20)

Deletes an assignment activity

Deletes all database records, files and calendar events for this newmodule. This is common to all assignment types.

newmodule_update_instance (20)

Updates a new newmodule activity

Given an object containing all the necessary data (defined by the form in mod.html), this function will update the newmodule instance and return the id number. The due date is updated in the calendar. This is common to all assignment types.

newmodule_get_participants (19)

Returns the users with data in one newmodule

(users with records in ???)

newmodule_user_complete (19)

Print complete information about the user's interaction with the newmodule

newmodule_user_outline (19)

Return an outline of the user's interaction with the assignment.

The default method prints the grade and timemodified.

newmodule_reset_userdata (12)

This function is used by the reset_course_userdata function in moodlelib.

This function will remove all posts from the specified newmodule and clean up any related data.

newmodule_reset_course_form_definition (10)

Implementation of the function for printing the form elements that control whether the course reset functionality affects the assignment.

newmodule_get_coursemodule_info

Can be used to customise how the module appears on the course page. The must be static information that only depends on the activity settings, not the currently logged in user, since it is cached. For an example see mod_label.

newmodule_cm_info_view

This callback lets you customise how the activity is displayed on the course page for the current user. An example is mod_forum which shows the number of unread forum messages for the current user.

newmodule_check_updates_since

Check if the module has any update that affects the current user since the given time.

Please refer to mod/assign/lib.php, mod/forum/lib.php or mod/quiz/lib.php for sample code.