Calendar API

The Calendar API allows you to add and modify events in the calendar for user, groups, courses, or the whole site.

Overview

The Moodle Calendar collects and displays calendar events from everything users have access to.

If your plugin generates calendar events (such as due dates) then you need to add your events to the calendar.

File locations

All the calendar code is located in /calendar/lib.php. You need to include this file in your script if you intend to use it.

The calendar_event class

All management of events that you might need to do can be done by the calendar_event() class.

(Rossi, describe this class and the methods available here - don't duplicate phpdocs but talk about the things that are possible in general. Try grouping all the functions into "clumps" that make sense)

Examples

Adding an event to the calendar

Dealing with files

etc

See also

• Calendar user docs