Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

Defines classes used for plugin info.

Copyright: 2016 Brendan Heywood (brendan@catalyst-au.net)
License: http://www.gnu.org/copyleft/gpl.html GNU Public License
File Size: 205 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: dataformat  - X-Ref

Class for dataformats

plugintype_supports_disabling()   X-Ref
No description

init_display_name()   X-Ref
Display name


get_plugins_sortorder(array $formats)   X-Ref
Given a list of dataformat types, return them sorted according to site configuration (if set)

param: string[] $formats List of formats, ['csv', 'pdf', etc]
return: string[] List of formats according to configured sort, ['csv', 'odf', etc]

get_plugins($type, $typerootdir, $typeclass, $pluginman)   X-Ref
Gathers and returns the information about all plugins of the given type

param: string $type the name of the plugintype, eg. mod, auth or workshopform
param: string $typerootdir full path to the location of the plugin dir
param: string $typeclass the name of the actually called class
param: core_plugin_manager $pluginman the plugin manager calling this method
return: array of plugintype classes, indexed by the plugin name

get_enabled_plugins()   X-Ref
Finds all enabled plugins, the result may include missing plugins.

return: array|null of enabled plugins $pluginname=>$pluginname, null means unknown

enable_plugin(string $pluginname, int $enabled)   X-Ref
No description

get_settings_section_name()   X-Ref
Returns the node name used in admin settings menu for this plugin settings (if applicable)

return: null|string node name or null if plugin does not create settings node (default)

load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig)   X-Ref
Loads plugin settings to the settings tree

This function usually includes settings.php file in plugins folder.
Alternatively it can create a link to some settings page (instance of admin_externalpage)

param: \part_of_admin_tree $adminroot
param: string $parentnodename
param: bool $hassiteconfig whether the current user has moodle/site:config capability

is_uninstall_allowed()   X-Ref
dataformats can be uninstalled

return: bool

get_manage_url()   X-Ref
Return URL used for management of plugins of this type.

return: moodle_url