| title |
|---|
API Guides |
Moodle has a number of core APIs that provide tools for Moodle scripts.
They are essential when writing Moodle plugins.
These APIs are critical and will be used by nearly every Moodle plugin.
The Access API gives you functions so you can determine what the current user is allowed to do, and it allows modules to extend Moodle with new capabilities.
The Data manipulation API allows you to read/write to databases in a consistent and safe way.
The File API controls the storage of files in connection to various plugins.
The Form API defines and handles user data via web forms.
The Events API allows you to log events in Moodle, while Logging 2 describes how logs are stored and retrieved.
The Navigation API allows you to manipulate the navigation tree to add and remove items as you wish.
The Page API is used to set up the current page, add JavaScript, and configure how things will be displayed to the user.
The Output API is used to render the HTML for all parts of the page.
The String API is how you get language text strings to use in the user interface. It handles any language translations that might be available.
The Upgrade API is how your module installs and upgrades itself, by keeping track of its own version.
The Moodlelib API is the central library file of miscellaneous general-purpose Moodle functions. Functions can over the handling of request parameters, configs, user preferences, time, login, mnet, plugins, strings and others. There are plenty of defined constants too.
The Admin settings API deals with providing configuration options for each plugin and Moodle core.
The Admin presets API allows plugins to make some decisions/implementations related to the Site admin presets.
The Analytics API allow you to create prediction models and generate insights.
The Availability API controls access to activities and sections.
The Backup API defines exactly how to convert course data into XML for backup purposes, and the Restore API describes how to convert it back the other way.
The The Moodle Universal Cache (MUC) is the structure for storing cache data within Moodle. Cache API explains some of what is needed to use a cache in your code.
The Calendar API allows you to add and modify events in the calendar for user, groups, courses, or the whole site.
The Check API allows you to add security, performance or health checks to your site.
The Comment API allows you to save and retrieve user comments, so that you can easily add commenting to any of your code.
The Communication API provides access to the messaging system and other communication providers (such as Matrix).
The Competency API allows you to list and add evidence of competencies to learning plans, learning plan templates, frameworks, courses and activities.
The Data definition API is what you use to create, change and delete tables and fields in the database during upgrades.
The Editor API is used to control HTML text editors.
The Enrolment API deals with course participants.
The Events API allows to define "events" with payload data to be fired whenever you like, and it also allows you to define handlers to react to these events when they happen. This is the recommended form of inter-plugin communication. This also forms the basis for logging in Moodle.
The Hooks API allows core and plugins to communicate indirectly with other plugins.
The Experience API (xAPI) is an e-learning standard that allows learning content and learning systems to speak to each other. The Experience API (xAPI) allows any plugin to generate and handle xAPI standard statements.
The External functions API allows you to create fully parametrised methods that can be accessed by external programs (such as Web services).
The Favourites API allows you to mark items as favourites for a user and manage these favourites. This is often referred to as 'Starred'.
The H5P API allows plugins to make some decisions/implementations related to the H5P integration.
The Lock API lets you synchronise processing between multiple requests, even for separate nodes in a cluster.
The Message API lets you post messages to users. They decide how they want to receive them.
The Media API can be used to embed media items such as audio, video, and Flash.
The My profile API is used to add things to the profile page.
The OAuth 2 API is used to provide a common place to configure and manage external systems using OAuth 2.
The Payment API deals with payments.
The Preference API is a simple way to store and retrieve preferences for individual users.
The Portfolio API allows you to add portfolio interfaces on your pages and allows users to package up data to send to their portfolios.
The Privacy API allows you to describe the personal data that you store, and provides the means for that data to be discovered, exported, and deleted on a per-user basis. This allows compliance with regulation such as the General Data Protection Regulation (GDPR) in Europe.
The Rating API lets you create AJAX rating interfaces so that users can rate items in your plugin. In an activity module, you may choose to aggregate ratings to form grades.
The Report builder API allows you to create reports in your plugin, as well as providing custom reporting data which users can use to build their own reports.
The RSS API allows you to create secure RSS feeds of data in your module.
The Search API allows you to index contents in a search engine and query the search engine for results.
The Tag API allows you to store tags (and a tag cloud) to items in your module.
The Task API lets you run jobs in the background. Either once off, or on a regular schedule.
The Time API takes care of translating and displaying times between users in the site.
The testing API contains the Unit test API (PHPUnit) and Acceptance test API (Acceptance testing). Ideally all new code should have unit tests written FIRST.
This is a rather informal grouping of miscellaneous User-related APIs relating to sorting and searching lists of users.
The Web services API allows you to expose particular functions (usually external functions) as web services.
The [https://docs.moodle.org/dev/OpenBadges_User_Documentation Badges] user documentation (is a temp page until we compile a proper page with all the classes and APIs that allows you to manage particular badges and OpenBadges Backpack).
The Custom fields API allows you to configure and add custom fields for different entities
Activity modules are the most important plugin in Moodle. There are several core APIs that service only Activity modules.
The Activity completion API is to indicate to the system how activities are completed.
The Advanced grading API allows you to add more advanced grading interfaces (such as rubrics) that can produce simple grades for the gradebook.
The deprecated Conditional activities API used to provide conditional access to modules and sections in Moodle 2.6 and below. It has been replaced by the Availability API.
The Groups API allows you to check the current activity group mode and set the current group.
The Gradebook API allows you to read and write from the gradebook. It also allows you to provide an interface for detailed grading information.
The Plagiarism API allows your activity module to send files and data to external services to have them checked for plagiarism.
The Question API (which can be divided into the Question bank API and the Question engine API), can be used by activities that want to use questions from the question bank.
- Plugins - plugin types also have their own APIs
- Callbacks - list of all callbacks in Moodle
- Coding style - general information about writing PHP code for Moodle
- Session locks