Migrating contrib code to 2.0: Difference between revisions

Latest revision as of 13:01, 4 January 2023

Warning: This page is no longer in use. The information contained on the page should NOT be seen as relevant or reliable.

This article is a stub. Please help improve Moodle Docs by editing it and adding some content.

Moodle 2.0

The goal of this page is to provide a checklist of tasks to be considered to upgrade CONTRIB code to Moodle 2.0. Several significant changes have taken place including the File API, DB Layer, Navigation, Output renderer, etc. It would be good if we had a list that contributors could follow to help move them toward being able to migrate the code. Any help in building up this list is greatly appreciated.

Please add useful links...

Installation

The 'requires' version in the plugin's version.php is checked to make sure it looks like Moodle 2.0. You should change this value to '2010112400' or later otherwise plugin installation will abort.

Database

DB_layer_2.0_migration_docs

File system

Forms API

Themes

Output_renderers
Text formats 2.0 how user-entered content is handled.
Migrating_your_code_to_the_2.0_rendering_API (n.b., some info outdated and may need updating)
Themes_2.0

Some details of how to re-design image CSS for plugin code are in the main themes documentation: Themes_2.0_creating_your_first_theme#Using_images_within_CSS

Be aware that themes are now cached on the server and so emptying your browser cache will not refresh the CSS. This can only be done by going to the site administration->appearance->themes->theme selector page and clicking the 'invalidate theme caches' button.

JavaScript

JavaScript is included in different ways now and will need to be migrated, see the PHPDoc comments in /lib/outputrequirements.lib and some (slightly outdated) advice here: JavaScript_guidelines

Backup and Restore

Miscellaneous

There are other coding changes such as:

MDL-24063 which eliminates PARAM_CLEAN
MDL-24058 about no longer using stripslashes or addslashes
Deprecated_functions_in_2.0
Upgrading blocks from Moodle 1.9 to Moodle 2.X: http://moodle.org/mod/forum/discuss.php?d=165086

Please feel free to add others that come to mind. CONTRIB maintainers should check their 2.0 versions for these and make sure that they are appropriately handled.

@@ Line 1: / Line 1: @@
+{{Template:WillNotMigrate}}
 {{stub}}
@@ Line 43: / Line 44: @@
 * MDL-24058 about no longer using stripslashes or addslashes
 * [[Deprecated_functions_in_2.0]]
+* Upgrading blocks from Moodle 1.9 to Moodle 2.X: http://moodle.org/mod/forum/discuss.php?d=165086
 Please feel free to add others that come to mind. CONTRIB maintainers should check their 2.0 versions for these and make sure that they are appropriately handled.
@@ Line 55: / Line 57: @@
 * [[Local_customisation]]
 * [[Migrating to 2.0 checklist]] list of things to look out for when upgrading a plug-in
+* [http://tandl.churchward.ca/2011/10/converting-m19-plug-ins-to-m2-block.html Mike Churchward's "Converting M1.9 Plug-ins to M2"]
 [[Category:Guidelines for contributors]]

Documentation