Skip to main content

Migrate from v1

info

V1 is deprecated. It only receives security updates and will be phased out.

Download the wordpress plugin v1 (deprecated) below:

How to migrate​

With version 2 of the plugin, many components have been completely rewritten to add support for Programs. This means that a migration is needed. Just updating the plugin won't work. We recommend contacting your website developer to do this migration.

warning

Upgrading from v1 to v2 introduces braking changes. Some custom written templates and styling will not continue to work. Updating the Wordpress plugin from v1 to v2+ without applying the necessary changes will break your website.

The recommended way of updating the Wordpress plugin is by duplicating your website. You can then start making the needed changes on the duplicated website while your current website is still live. When done you can replace your current website with the new updated one.

The following is a step by step guide to get you through the upgrade:

  1. Duplicate your website and continue with this list on the duplicate website.
  2. Upgrade the Eduframe plugin to latest version and run the full sync. This will render some of your website pages as broken. We will be fixing this in the following steps.
  3. Go through all the pages where you're using an Eduframe widget (like showing a list of courses). Remove the old widgets and replace them with the new ones. You should be able to select the new products and variants widgets by using your page editor. You can read about these new widgets here.
  4. Re-create all your template overrides in your theme if you had any. We renamed all courses to products and planned_courses to variants. You should go over all the pages that this plugin adds, copy the new template files and override these with your styling/layout.
  5. If you have been using a custom signup page, you should deactivate/remove this page for now. If you want a custom signup you will have to build one from scratch as the new version doesn't provide one anymore.
  6. The plugin new version does not show the credits of courses by default. If you still want to display the credits, you will have to manually add this to the templates in your custom theme.
  7. You need to save the WP Permalinks settings again. Within the WordPress admin portal, go to 'Settings' -> 'Permalinks', under 'Common Settings' you should choose the option called 'Post name' and click save.

At this point you're ready to replace your current website with the new website you have build above. After switching you should still do a couple of things:

  1. In case you're adding the {{planned_courses}} short code to your course tabs manually (to show a list of planned courses), you will have to replace these with the new {{variants}} short code.
  2. Add additional events to the website webhook setup in Eduframe. Read more about the required events here.
  3. Run the full sync again.

After successfully completing the steps above, you're done with the upgrade! If you run into any problems that are not addressed above, please contact us through support.