Skip to content

Commit ab099a5

Browse files
committed
[docs] course format update note
Add an upgrade note about all YUI and 3.11 course format deprecation in Moodle 5.0
1 parent f297f41 commit ab099a5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/devupdate.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,3 +85,23 @@ $activity-icon-interactivecontent-bg: #c70827;
8585
```
8686

8787
:::
88+
89+
## Course formats
90+
91+
<Since version="5.0" issueNumber="MDL-83527" />
92+
93+
All course formats created for Moodle versions prior to 4.0, which still depend on the 3.11 libraries, will be deprecated starting from Moodle 5.0 and will no longer function in Moodle 6.0. We are discontinuing the use of YUI for course editing and transitioning the course display logic to output classes.
94+
95+
You can determine if your course format is impacted by this change by examining the `lib.php` file within your plugin directory. If the format class does not override the `supports_components` method, or if the method returns `false`, it indicates that the course format relies on the deprecated YUI libraries and requires updating.
96+
97+
To ensure a smooth transition, we have documented the migration process in detail. Please refer to the [migration guide](./apis/plugintypes/format/migration.md) for comprehensive instructions on updating your course formats to be compatible with the latest Moodle standards.
98+
99+
### Course action menu outputs classes
100+
101+
<Since version="5.0" issueNumber="MDL-83527" />
102+
103+
The section and activity action menus now utilize output classes instead of global functions. The new classes are:
104+
105+
- `core_courseformat\output\local\content\cm\controlmenu`: the class now fully replaces the old `course_get_cm_edit_actions` function. Extend this class in your format plugin to add more options to the activity menu.
106+
- `core_courseformat\output\local\content\section\controlmenu`: the existing class has been refactored and now uses `action_menu_link` objects instead. If your format add more options to the section menu, you should update your code to use the new class instead of using arrays.
107+
- `core_courseformat\output\local\content\cm\delegatedcontrolmenu`: like the section control menu, the existing class has been refactored to use `action_menu_link` objects instead of arrays.

0 commit comments

Comments
 (0)