Skip to content

Installation

Stephen Vickers edited this page Dec 6, 2022 · 2 revisions

The plugin is written in PHP for use with WordPress 3.5 (or later). It uses the open source PHP LTI class library for handling the LTI-related communications. It is installed in the same way as other WordPress plugins which involves two steps:

  1. Add the source files to the WordPress server.
  2. Enable the plugin in WordPress.

Source files

WordPress plugin repository

This plugin is available from the WordPress plugin repository and so can be installed as follows:

  1. Navigate to the Plugins page of the Administrator dashboard.
  2. Click on the Add New button.
  3. Enter LTI Platform as the Keyword.
  4. Click on the Install Now button for the LTI Platform plugin.

Repeat the above steps to install the ceLTIc LTI Library plugin (version 4.10.0, or later) and activate it once installed.

Using Composer

The source files can be installed on the WordPress server using composer:

  1. Log into the WordPress server.
  2. Navigate to the wp-content/plugins directory of the WordPress installation.
  3. Run the command composer create-project celtic/wordpress-lti-platform lti-platform.

Manually

Alternatively the source files and dependencies can be added manually by extracting the source files from this repository into a directory named lti-platform within the plugins area of your WordPress instance and following the manual instructions in the LTI class library documentation for installing the LTI library and its dependencies (or install the ceLTIc LTI Library plugin from the WordPress plugin repository, as above).

Enable the plugin

  1. Log into WordPress as an administrator.
  2. Navigate to the Admin Dashboard (for the network when using a multisite instance of WordPress).
  3. Select the Activate option on the Plugins page to enable the plugin.

Plugins page in the Admin Dashboard

Once enabled, the plugin a new menu option named LTI Tools will appear in the Settings menu of a site's admin dashboard. A menu option named Network LTI Tools will also be added to the Settings menu of the network admin dashboard when using a multisite instance of WordPress.

Updating the plugin

  • When updating to version 2.1.0 check that version 4.10.0 (or later) of the ceLTIc LTI Library (plugin or source files) is also installed.
  • Version 2.1.0 introduces a setting for role mappings - review each tool which has been configure to ensure that the default role mappings are appropriate.

Removing the plugin

To completely remove the plugin from the WordPress installation use the Deactivate option on the Plugins page in the Admin Dashboard, and then select the Delete option for the plugin. To permanently remove the data created by the plugin from the WordPress instance, ensure that the following option has been checked before it is deactivated:

  • Delete data on uninstall?

This will remove any LTI tool configurations as well as the plugin option settings.