Repository navigation
Conversation
HuongNV13
requested review from
andrewnicols
and removed request for
a team and
Copilot
November 3, 2026 04:01
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Copilot stopped reviewing on behalf of
HuongNV13 due to an error
November 3, 2026 04:02
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Active findings include a build-blocking missing import and multiple moderate and documentation-example errors that make the versioned content unreliable to use.
18 open issues
Add or remove missing versioned PHP example imports · New Define the database manager in the upgrade example · New Use the example plugin name in the template path · New Register the field-controller example as a checkbox · New Correct the inverted initialization guard · New Fix relative path to the versioned JavaScript guide · New Use version-aware links to the AI API documentation · New Fix the question subsystem link from the qbank page · New Fix the question subsystem link from the qtype page · New Remove the duplicated qtype segment from the link · New Fix the quizaccess link to common-files documentation · New Align the restore class name with the example · New Terminate the get_file_info assignment with a semicolon · New Show the default value for the optional originalvalue argument · New Fix the relative link to the choice dropdown field · New Declare a scope for the API route example · New Update the PHP requirements for Moodle 5.3 · New Use the defined component variable in the example · New
What changed in this PR
This pull request archives and publishes the Moodle 5.3 developer documentation, advances the active documentation site to Moodle 6.0, and updates navigation, redirects, and release metadata.
Changes:
- Adds the Moodle 5.3 version registry, sidebar, and versioned documentation tree.
- Adds or updates QA, API, plugin, JavaScript, and developer guidance.
- Updates current-version redirects, release pages, landing pages, and release metadata.
| File | Change |
|---|---|
versions.json |
Registers Moodle 5.3 documentation. |
versioned_sidebars/version-5.3-sidebars.json |
Adds Moodle 5.3 navigation. |
versioned_docs/version-5.3/qatesting/commonterms.md |
Adds QA terminology. |
versioned_docs/version-5.3/qatesting.md |
Adds QA testing guidance. |
versioned_docs/version-5.3/intro.md |
Adds the Moodle 5.3 introduction. |
versioned_docs/version-5.3/guides/rest/index.md |
Adds REST guide documentation. |
versioned_docs/version-5.3/guides/javascript/yui/namespacing.md |
Documents YUI namespacing. |
versioned_docs/version-5.3/guides/javascript/react/profiler.md |
Documents React profiling. |
versioned_docs/version-5.3/guides/javascript/react/index.md |
Adds the React guide overview. |
versioned_docs/version-5.3/guides/javascript/comboboxsearch/examples.md |
Adds combobox search examples. |
versioned_docs/version-5.3/guides/javascript/_examples/str.js |
Adds a JavaScript string example. |
versioned_docs/version-5.3/guides/javascript/_examples/promises/getModal.js |
Adds a modal Promise example. |
versioned_docs/version-5.3/guides.md |
Adds the developer guides index. |
versioned_docs/version-5.3/gettingstarted/requirements.md |
Documents technical requirements. |
versioned_docs/version-5.3/devupdate.md |
Adds the Moodle 5.3 developer update. |
versioned_docs/version-5.3/apis/telemetry/index.mdx |
Adds OpenTelemetry documentation. |
versioned_docs/version-5.3/apis/subsystems/task/scheduled.md |
Documents scheduled tasks. |
versioned_docs/version-5.3/apis/subsystems/routing/index.md |
Adds routing API documentation. |
versioned_docs/version-5.3/apis/subsystems/plagiarism.md |
Adds plagiarism API documentation. |
versioned_docs/version-5.3/apis/subsystems/output/humandate.md |
Documents human-readable date output. |
versioned_docs/version-5.3/apis/subsystems/form/fields/choicedropdown.md |
Documents the choice dropdown field. |
versioned_docs/version-5.3/apis/subsystems/form/fields/_category_.yml |
Configures form-field navigation. |
versioned_docs/version-5.3/apis/subsystems/form/advanced/no-submit-button.md |
Documents no-submit form buttons. |
versioned_docs/version-5.3/apis/subsystems/form/advanced/checkbox-controller.md |
Documents checkbox controllers. |
versioned_docs/version-5.3/apis/subsystems/form/advanced/advanced-elements.md |
Documents advanced form elements. |
versioned_docs/version-5.3/apis/subsystems/form/advanced/_category_.yml |
Configures advanced-form navigation. |
versioned_docs/version-5.3/apis/subsystems/files/browsing.md |
Documents file browsing. |
versioned_docs/version-5.3/apis/subsystems/external/security.md |
Documents external-service security. |
versioned_docs/version-5.3/apis/subsystems/external/index.md |
Adds the external services overview. |
versioned_docs/version-5.3/apis/subsystems/external/description.md |
Documents external function declarations. |
versioned_docs/version-5.3/apis/subsystems/external/advanced/custom-services.md |
Documents custom web services. |
versioned_docs/version-5.3/apis/subsystems/external/advanced/_category_.json |
Configures external-service navigation. |
versioned_docs/version-5.3/apis/subsystems/editor/index.md |
Adds editor API documentation. |
versioned_docs/version-5.3/apis/subsystems/badges/index.md |
Adds badges API documentation. |
versioned_docs/version-5.3/apis/subsystems/backup/restore.md |
Documents restore API behavior. |
versioned_docs/version-5.3/apis/subsystems/_category_.yml |
Configures subsystem navigation. |
versioned_docs/version-5.3/apis/plugintypes/theme/fonts.md |
Documents theme fonts. |
versioned_docs/version-5.3/apis/plugintypes/theme/_examples/lang.php |
Adds a theme language-string example. |
versioned_docs/version-5.3/apis/plugintypes/theme/_examples/lang.md |
Documents theme language strings. |
versioned_docs/version-5.3/apis/plugintypes/repository/_examples/lib.php |
Adds a repository implementation example. |
versioned_docs/version-5.3/apis/plugintypes/repository/_examples/flickr_public_lib.php |
Adds a Flickr repository example. |
versioned_docs/version-5.3/apis/plugintypes/repository/_examples/access.php |
Adds repository capability examples. |
versioned_docs/version-5.3/apis/plugintypes/quizaccess/index.md |
Documents quiz access-rule plugins. |
versioned_docs/version-5.3/apis/plugintypes/quizaccess/_examples/rule.md |
Describes quiz access-rule examples. |
versioned_docs/version-5.3/apis/plugintypes/quizaccess/_examples/rule_overridable.md |
Describes overridable quiz rules. |
versioned_docs/version-5.3/apis/plugintypes/qtype/newquestiondefaults.md |
Documents question defaults. |
versioned_docs/version-5.3/apis/plugintypes/qtype/index.md |
Adds question-type documentation. |
versioned_docs/version-5.3/apis/plugintypes/qbank/index.md |
Adds question-bank documentation. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/view-php.tsx |
Adds the activity view component. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/view-php.mdx |
Describes activity view pages. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/mod_form-php.txt |
Adds a module form example. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/mod_form-php.mdx |
Describes module forms. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/install_description.md |
Describes activity database requirements. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/index-php.tsx |
Adds the activity index component. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/index-php.mdx |
Describes activity index pages. |
versioned_docs/version-5.3/apis/plugintypes/mod/_files/access_description.md |
Describes activity capabilities. |
versioned_docs/version-5.3/apis/plugintypes/mod_forum/index.md |
Adds forum sub-plugin documentation. |
versioned_docs/version-5.3/apis/plugintypes/mod_data/presets.md |
Documents database presets. |
versioned_docs/version-5.3/apis/plugintypes/mod_data/index.md |
Adds database activity documentation. |
versioned_docs/version-5.3/apis/plugintypes/mod_data/fields.md |
Documents database field plugins. |
versioned_docs/version-5.3/apis/plugintypes/mod_book/index.md |
Adds book sub-plugin documentation. |
versioned_docs/version-5.3/apis/plugintypes/logstore/index.md |
Adds logstore documentation. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/renderer.php |
Adds course-format renderer examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/pluginskel_recipe.yaml |
Adds a format plugin recipe. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/section.php |
Adds section output examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/section.mustache |
Adds section template examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/renderer.php |
Adds output renderer examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/content.php |
Adds content output examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/content.mustache |
Adds content template examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/cmitem.php |
Adds course-module output examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/output/cmitem.mustache |
Adds course-module template examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/lib.php |
Adds course-format implementation examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/lib_course_index.php |
Adds course-index examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/lib_components.php |
Adds component-support examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/format.php |
Adds course-format page examples. |
versioned_docs/version-5.3/apis/plugintypes/format/_examples/format_lang.php |
Adds course-format language strings. |
versioned_docs/version-5.3/apis/plugintypes/filter/_examples/filter.php |
Adds text-filter examples. |
versioned_docs/version-5.3/apis/plugintypes/filter/_examples/dynamic.js |
Adds dynamic-filter JavaScript examples. |
versioned_docs/version-5.3/apis/plugintypes/fileconverter/_files/converter.tsx |
Adds the file-converter component. |
versioned_docs/version-5.3/apis/plugintypes/fileconverter/_files/converter.md |
Describes file-converter implementations. |
versioned_docs/version-5.3/apis/plugintypes/enrol/_examples/message_lib.php |
Adds enrolment message examples. |
versioned_docs/version-5.3/apis/plugintypes/enrol/_examples/lib.php |
Adds enrolment plugin examples. |
versioned_docs/version-5.3/apis/plugintypes/enrol/_examples/enrol_lang.php |
Adds enrolment language strings. |
versioned_docs/version-5.3/apis/plugintypes/enrol/_examples/access.php |
Adds enrolment capability examples. |
versioned_docs/version-5.3/apis/plugintypes/customfield/_files/field_controller.tsx |
Adds custom-field controller documentation. |
versioned_docs/version-5.3/apis/plugintypes/customfield/_files/field_controller.php |
Adds a field-controller example. |
versioned_docs/version-5.3/apis/plugintypes/customfield/_files/data_controller.tsx |
Adds custom-field data-controller documentation. |
versioned_docs/version-5.3/apis/plugintypes/customfield/_files/data_controller.php |
Adds a data-controller example. |
versioned_docs/version-5.3/apis/plugintypes/blocks/_examples/pluginskel_recipe.yaml |
Adds a block plugin recipe. |
versioned_docs/version-5.3/apis/plugintypes/blocks/_examples/edit_form.php |
Adds block form examples. |
versioned_docs/version-5.3/apis/plugintypes/blocks/_examples/block_pluginname.php |
Adds block implementation examples. |
versioned_docs/version-5.3/apis/plugintypes/blocks/_examples/access.php |
Adds block capability examples. |
versioned_docs/version-5.3/apis/plugintypes/availability/_examples/lang.php |
Adds availability language strings. |
versioned_docs/version-5.3/apis/plugintypes/availability/_examples/lang.md |
Documents availability language strings. |
versioned_docs/version-5.3/apis/plugintypes/atto/_examples/lib.php |
Adds Atto callback examples. |
versioned_docs/version-5.3/apis/plugintypes/atto/_examples/lib.md |
Documents Atto callbacks. |
versioned_docs/version-5.3/apis/plugintypes/atto/_examples/button.tsx |
Adds an Atto button example. |
versioned_docs/version-5.3/apis/plugintypes/atto/_examples/button.md |
Describes Atto button modules. |
versioned_docs/version-5.3/apis/plugintypes/assign/index.md |
Adds assignment sub-plugin documentation. |
versioned_docs/version-5.3/apis/plugintypes/assign/_files/submission_settings.php |
Adds assignment submission settings. |
versioned_docs/version-5.3/apis/plugintypes/antivirus/_files/scanner-php.tsx |
Adds the antivirus scanner component. |
versioned_docs/version-5.3/apis/plugintypes/antivirus/_files/scanner-php.mdx |
Describes antivirus scanner implementations. |
versioned_docs/version-5.3/apis/plugintypes/ai/index.md |
Adds the AI plugin overview. |
versioned_docs/version-5.3/apis/core/lock/index.md |
Documents the lock API. |
versioned_docs/version-5.3/apis/core/index.md |
Adds the core API index. |
versioned_docs/version-5.3/apis/core/dml/exceptions.md |
Documents DML exceptions. |
versioned_docs/version-5.3/apis/core/dml/drivers.md |
Documents DML drivers. |
versioned_docs/version-5.3/apis/_files/yui-dir.tsx |
Adds the YUI directory component. |
versioned_docs/version-5.3/apis/_files/yui-dir.mdx |
Describes YUI modules. |
versioned_docs/version-5.3/apis/_files/version-php.tsx |
Adds the version metadata component. |
versioned_docs/version-5.3/apis/_files/version-php.mdx |
Describes version.php. |
versioned_docs/version-5.3/apis/_files/upgrade-txt.tsx |
Adds the upgrade notes component. |
versioned_docs/version-5.3/apis/_files/upgrade-txt.mdx |
Describes upgrade.txt. |
versioned_docs/version-5.3/apis/_files/upgrade-php.mdx |
Describes upgrade hooks. |
versioned_docs/version-5.3/apis/_files/thirdpartylibs-xml.tsx |
Adds the third-party libraries component. |
versioned_docs/version-5.3/apis/_files/thirdpartylibs-xml.mdx |
Describes thirdpartylibs.xml. |
versioned_docs/version-5.3/apis/_files/styles-css.tsx |
Adds the stylesheet component. |
versioned_docs/version-5.3/apis/_files/styles-css.mdx |
Describes plugin stylesheets. |
versioned_docs/version-5.3/apis/_files/settings-php.tsx |
Adds the settings component. |
versioned_docs/version-5.3/apis/_files/settings-php.mdx |
Describes plugin settings. |
versioned_docs/version-5.3/apis/_files/readme.tsx |
Adds the README component. |
versioned_docs/version-5.3/apis/_files/readme.mdx |
Describes plugin README files. |
versioned_docs/version-5.3/apis/_files/readme_moodle-txt.tsx |
Adds the third-party README component. |
versioned_docs/version-5.3/apis/_files/readme_moodle-txt.mdx |
Describes readme_moodle.txt. |
versioned_docs/version-5.3/apis/_files/pix-dir.tsx |
Adds the plugin-icons component. |
versioned_docs/version-5.3/apis/_files/pix-dir.mdx |
Describes plugin icons. |
versioned_docs/version-5.3/apis/_files/locallib.tsx |
Adds the locallib.php component. |
versioned_docs/version-5.3/apis/_files/locallib.mdx |
Describes legacy local libraries. |
versioned_docs/version-5.3/apis/_files/lib.tsx |
Adds the lib.php component. |
versioned_docs/version-5.3/apis/_files/lib.mdx |
Describes legacy plugin functions. |
versioned_docs/version-5.3/apis/_files/lang.tsx |
Adds the language-file component. |
versioned_docs/version-5.3/apis/_files/lang.md |
Describes plugin language files. |
versioned_docs/version-5.3/apis/_files/lang-extra.md |
Documents activity-module language files. |
versioned_docs/version-5.3/apis/_files/install-xml.tsx |
Adds the database schema component. |
versioned_docs/version-5.3/apis/_files/index.tsx |
Exports common file components. |
versioned_docs/version-5.3/apis/_files/environment-xml.tsx |
Adds the environment requirements component. |
versioned_docs/version-5.3/apis/_files/environment-xml.mdx |
Describes environment.xml. |
versioned_docs/version-5.3/apis/_files/db-upgrade-php.tsx |
Adds the upgrade-file component. |
versioned_docs/version-5.3/apis/_files/db-upgrade-php.mdx |
Describes upgrade steps. |
versioned_docs/version-5.3/apis/_files/db-uninstall-php.tsx |
Adds the uninstall-hook component. |
versioned_docs/version-5.3/apis/_files/db-uninstall-php.mdx |
Describes uninstall hooks. |
versioned_docs/version-5.3/apis/_files/db-tasks-php.tsx |
Adds the scheduled-task component. |
versioned_docs/version-5.3/apis/_files/db-tasks-php.mdx |
Describes scheduled tasks. |
versioned_docs/version-5.3/apis/_files/db-tasks-example.php |
Adds a scheduled-task example. |
versioned_docs/version-5.3/apis/_files/db-services-php.tsx |
Adds the service declaration component. |
versioned_docs/version-5.3/apis/_files/db-services-php.mdx |
Describes service declarations. |
versioned_docs/version-5.3/apis/_files/db-renamedclasses-php.tsx |
Adds the renamed-classes component. |
versioned_docs/version-5.3/apis/_files/db-renamedclasses-php.mdx |
Describes renamed classes. |
versioned_docs/version-5.3/apis/_files/db-mobile-php.tsx |
Adds the Moodle App component. |
versioned_docs/version-5.3/apis/_files/db-mobile-php.mdx |
Describes Moodle App add-ons. |
versioned_docs/version-5.3/apis/_files/db-messages-php.tsx |
Adds the message-provider component. |
versioned_docs/version-5.3/apis/_files/db-messages-php.mdx |
Describes message providers. |
versioned_docs/version-5.3/apis/_files/db-legacyclasses-php.tsx |
Adds the legacy-classes component. |
versioned_docs/version-5.3/apis/_files/db-legacyclasses-php.mdx |
Describes legacy class mappings. |
versioned_docs/version-5.3/apis/_files/db-install-xml.mdx |
Describes database schema files. |
versioned_docs/version-5.3/apis/_files/db-install-php.tsx |
Adds the install-hook component. |
versioned_docs/version-5.3/apis/_files/db-install-php.mdx |
Describes installation hooks. |
versioned_docs/version-5.3/apis/_files/db-events-php.tsx |
Adds the event-observer component. |
versioned_docs/version-5.3/apis/_files/db-events-php.mdx |
Describes event observers. |
versioned_docs/version-5.3/apis/_files/db-access-php.tsx |
Adds the capabilities component. |
versioned_docs/version-5.3/apis/_files/db-access-php.mdx |
Describes plugin capabilities. |
versioned_docs/version-5.3/apis/_files/composer-json.tsx |
Adds the Composer component. |
versioned_docs/version-5.3/apis/_files/composer-json.mdx |
Describes composer.json. |
versioned_docs/version-5.3/apis/_files/cli-dir.tsx |
Adds the CLI directory component. |
versioned_docs/version-5.3/apis/_files/cli-dir.mdx |
Describes CLI scripts. |
versioned_docs/version-5.3/apis/_files/classes-dir.tsx |
Adds the classes-directory component. |
versioned_docs/version-5.3/apis/_files/classes-dir.mdx |
Describes autoloaded classes. |
versioned_docs/version-5.3/apis/_files/changes.tsx |
Adds the changelog component. |
versioned_docs/version-5.3/apis/_files/changes.mdx |
Describes plugin changelogs. |
versioned_docs/version-5.3/apis/_files/backup-dir.tsx |
Adds the backup-directory component. |
versioned_docs/version-5.3/apis/_files/backup-dir.mdx |
Describes plugin backup support. |
versioned_docs/version-5.3/apis/_files/amd-dir.tsx |
Adds the AMD directory component. |
versioned_docs/version-5.3/apis/_files/amd-dir.mdx |
Describes AMD modules. |
static/_redirects |
Updates documentation redirects for Moodle 6.0. |
nextVersion.js |
Sets Moodle 6.0 as the current version. |
general/releases/5.3.md |
Updates the Moodle 5.3 documentation link. |
docs/intro.md |
Updates the current documentation introduction. |
docs/devupdate.md |
Resets the active developer update. |
data/versions.json |
Adds Moodle 6.0 and 6.1 release metadata. |
Review effort: Lite
Comment on lines
+57
to
+58
| import RuleFile from '!!raw-loader!./_examples/rule.php'; | ||
| import RuleDescription from './_examples/rule.md'; |
|
|
||
| const defaultExample = ` | ||
| function xmldb_certificate_upgrade($oldversion = 0) { | ||
| if ($oldversion < 2012091800) { |
| // Add logic here to define your template data or any other content. | ||
| $data = ['YOUR DATA GOES HERE']; | ||
|
|
||
| $this->content->text = $OUTPUT->render_from_template('block_yourplugin/content', $data); |
| class field_controller extends \core_customfield\field_controller { | ||
|
|
||
| /** @var string Plugin type */ | ||
| const TYPE = 'radio'; |
Comment on lines
+13
to
+16
| if (!firstLoad) { | ||
| return; | ||
| } | ||
| firstLoad = true; |
| $groupid = null, | ||
| string $text = null, | ||
| mixed $attributes = null, | ||
| int $originalvalue |
|
|
||
| 1. [Autocomplete](https://docs.moodle.org/dev/lib/formslib.php_Form_Definition#autocomplete) - A select box that allows you to start typing to narrow the list of options, or search for results. | ||
| 1. [advcheckbox](https://docs.moodle.org/dev/lib/formslib.php_Form_Definition#advcheckbox) - Advance checkbox | ||
| 1. [choicedropdown](./form/fields/choicedropdown) - A dropdown menu where custom information is displayed on each option. |
Comment on lines
+58
to
+61
| #[\core\router\route( | ||
| // Resolves to https://example.com/moodle/api/rest/v2/mod_example/example | ||
| path: '/example', | ||
| )] |
Comment on lines
+11
to
+15
| Moodle 4.0 supports the following PHP versions: | ||
|
|
||
| - 7.3 | ||
| - 7.4 | ||
| - 8.0 |
Comment on lines
+42
to
+52
| $searchdropdows = new comboboxsearch( | ||
| true, | ||
| 'Trigger button content', | ||
| null, | ||
| 'parent-class', | ||
| 'trigger-button-class', | ||
| 'search-dropdown-class', | ||
| null, | ||
| false, | ||
| ); | ||
| $data['templatevalue'] = $searchdropdown->export_for_template(\renderer_base); |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Per point 6 of https://moodledev.io/general/development/process/release#2-weeks-after