API documentation — Moodle Workplace

Cited by

Facts read from this source

• Access API Report an error

  “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.”

• Dml API Report an error

  “The Data manipulation API allows you to read/write to databases in a consistent and safe way.”

• Privacy API GDPR Report an error

  “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.”

• External API Report an error

  “The External functions API allows you to create fully parametrised methods that can be accessed by external programs (such as Web services).”

• Webservice API Report an error

  “The Web services API allows you to expose particular functions (usually external functions) as web services.”

• Oauth2 API Report an error

  “The OAuth 2 API is used to provide a common place to configure and manage external systems using OAuth 2.”

• Task API Report an error

  “The Task API lets you run jobs in the background. Either once off, or on a regular schedule.”

• Cache API Report an error

  “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.”

• Lock API Report an error

  “The Lock API lets you synchronise processing between multiple requests, even for separate nodes in a cluster.”

• Payment API Report an error

  “The Payment API deals with payments.”

• Xapi API Report an error

  “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.”

• Events API Report an error

  “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.”

• Hooks API Report an error

  “The Hooks API allows core and plugins to communicate indirectly with other plugins.”

• Search API Report an error

  “The Search API allows you to index contents in a search engine and query the search engine for results.”

• Rss API Report an error

  “The RSS API allows you to create secure RSS feeds of data in your module.”

• Gradebook API Report an error

  “The Gradebook API allows you to read and write from the gradebook. It also allows you to provide an interface for detailed grading information.”

• Question API Report an error

  “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.”

• Backup API Report an error

  “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.”

• Analytics API Report an error

  “The Analytics API allow you to create prediction models and generate insights.”

• Testing API Report an error

  “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.”

• Opentelemetry Report an error

  “The Open Telemetry integration allows administrators to observe the impact of various Moodle features and functionality.”

• Communication API Report an error

  “The Communication API provides access to the messaging system and other communication providers (such as Matrix).”

• Enrolment API Report an error

  “The Enrolment API deals with course participants.”

• Deprecated condition API Report an error

  “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.”

• Docs version Report an error

  “Version: main (5.3)”

• Docs last updated Report an error

  “Last updated on 27 Apr 2026 by Andrew Nicols”

• Copyright entity Report an error

  “Copyright © 2026 Moodle Pty Ltd. Built with Docusaurus.”

Scores citing this record

• The Compliance Officer Courses, learning paths & content standards
• The Compliance Officer Compliance training, recertification & audit trail
• The Compliance Officer Onboarding, extended enterprise & academies
• The Compliance Officer Reporting, learner data & works council
• The Compliance Officer Integrations, administration & portability
• The Compliance Officer European sovereignty
• The Customer Education Lead Courses, learning paths & content standards
• The Customer Education Lead Compliance training, recertification & audit trail
• The Customer Education Lead Onboarding, extended enterprise & academies
• The Customer Education Lead Reporting, learner data & works council
• The Customer Education Lead Integrations, administration & portability
• The Customer Education Lead European sovereignty
• The IT & HR Systems Admin Courses, learning paths & content standards
• The IT & HR Systems Admin Compliance training, recertification & audit trail
• The IT & HR Systems Admin Onboarding, extended enterprise & academies
• The IT & HR Systems Admin Reporting, learner data & works council
• The IT & HR Systems Admin Integrations, administration & portability
• The IT & HR Systems Admin European sovereignty
• The Onboarding Lead Courses, learning paths & content standards
• The Onboarding Lead Compliance training, recertification & audit trail
• The Onboarding Lead Onboarding, extended enterprise & academies
• The Onboarding Lead Reporting, learner data & works council
• The Onboarding Lead Integrations, administration & portability
• The Onboarding Lead European sovereignty
• The Skeptic Courses, learning paths & content standards
• The Skeptic Compliance training, recertification & audit trail
• The Skeptic Onboarding, extended enterprise & academies
• The Skeptic Reporting, learner data & works council
• The Skeptic Integrations, administration & portability
• The Skeptic European sovereignty
• The Works Council Member Courses, learning paths & content standards
• The Works Council Member Compliance training, recertification & audit trail
• The Works Council Member Onboarding, extended enterprise & academies
• The Works Council Member Reporting, learner data & works council
• The Works Council Member Integrations, administration & portability
• The Works Council Member European sovereignty