[docs] Next/Previous activity navigation API - #1662
Merged
Merged
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the Moodle developer documentation around linear navigation by documenting how the “Previous”/“Next” activity controls resolve destinations, what gets skipped, and how activity modules can override or suppress their navigation URL via \core_course\cm_info navigation URL APIs.
Changes:
- Mention activity-module participation in linear navigation in the Moodle 5.3 developer update.
- Add module-facing documentation for overriding/excluding the linear navigation URL via
modname_cm_info_dynamic(). - Add a dedicated “Next and previous activity navigation” section describing routing, skip rules, and override APIs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/devupdate.md | Adds a dev-update note about cm_info navigation URL APIs for linear navigation. |
| docs/apis/plugintypes/mod/visibility.md | Documents how modules can override or null out the navigation URL (and links to the full rules). |
| docs/apis/plugintypes/format/linear_navigation.md | Documents previous/next routing behavior, skip rules, and cm_info navigation URL override/reset APIs. |
Document how the "Previous" and "Next" controls resolve their target, which activities are skipped (including modules without FEATURE_CAN_DISPLAY, MDL-88003), and how activity modules can override or suppress their navigation URL via cm_info::set_navigation_url().
aanabit
requested changes
Jul 29, 2026
aanabit
approved these changes
Jul 29, 2026
aanabit
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for the changes, Sara.
The patch seems OK to me now and explains the important information devs should know about.
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.
Document how the "Previous" and "Next" controls resolve their target, which activities are skipped (including modules without FEATURE_CAN_DISPLAY, MDL-88003), and how activity modules can override or suppress their navigation URL via cm_info::set_navigation_url().