Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/classes/plugininfo/ -> tool.php (source)

[Source view]

Differences Between: [Versions 400 and 402] [Versions 400 and 403]

Defines classes used for plugin info.

Copyright: 2011 David Mudrak <david@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 84 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

tool:: (4 methods):
  is_uninstall_allowed()
  is_enabled()
  get_manage_url()
  load_settings()


Class: tool  - X-Ref

Class for admin tool plugins

is_uninstall_allowed()   X-Ref
No description

is_enabled()   X-Ref
Tools cannot be disabled.

return: boolean

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

return: moodle_url

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