[docs] Supplementary content in the sticky footer#1636
Open
sarjona wants to merge 1 commit into
Open
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 updates the Moodle 5.3 DevDocs to document the new $PAGE supplementary content API for adding an action_link to the sticky footer, decoupled from course format linear navigation support (MDL-88601).
Changes:
- Adds a Moodle 5.3 developer update entry describing
set_supplementary_content()/get_supplementary_content()and a real-worldmod_forumuse case. - Extends the linear navigation guide with a new section explaining how to add supplementary sticky-footer content, including a PHP example and behavioral notes.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/devupdate.md | Adds a new Moodle 5.3 dev update entry describing supplementary sticky-footer content and links to the detailed guide section. |
| docs/apis/plugintypes/format/linear_navigation.md | Documents how to set/retrieve supplementary sticky-footer content and how it interacts with linear navigation rendering. |
Document the new moodle_page::set_supplementary_content() and get_supplementary_content() methods introduced in MDL-88601, which allow injecting additional content into the sticky footer independently of course format linear navigation support, as used by mod_forum to link back to the discussion list.
sarjona
force-pushed
the
supplementarycontent
branch
from
32fb02c to
882cea5
Compare
Collaborator
|
Thanks @sarjona, all good. |
|
|
||
| <Since version="5.3" issueNumber="MDL-88601" /> | ||
|
|
||
| Independently of whether the current course format supports linear navigation, any part of Moodle can request additional content to be displayed in the sticky footer by calling `moodle_page->set_supplementary_content()` with an `action_link` instance: |
Member
Author
There was a problem hiding this comment.
I don't think it's a good idea to replace moodle_page-> with $PAGE (I updated the patch replacing :: with -> but that's all).
|
|
||
| When supplementary content is set, the sticky footer is displayed even if the course format does not support linear navigation, or the setting is disabled, showing only the supplementary content. If linear navigation is also enabled, both the navigation controls and the supplementary content are rendered together in the footer, separated by a border. | ||
|
|
||
| Use `moodle_page->get_supplementary_content()` to retrieve the current value, which returns `null` if none has been set. The value is automatically reset whenever `moodle_page->reset_theme_and_output()` is called. |
Member
Author
There was a problem hiding this comment.
I don't think it's a good idea to replace moodle_page-> with $PAGE (I updated the patch replacing :: with -> but that's all).
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 the new moodle_page::set_supplementary_content() and get_supplementary_content() methods introduced in MDL-88601, which allow injecting additional content into the sticky footer independently of course format linear navigation support, as used by mod_forum to link back to the discussion list.