Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/classes/plugininfo/ -> block.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 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: 192 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

block:: (10 methods):
  get_enabled_plugins()
  enable_plugin()
  __get()
  init_display_name()
  get_settings_section_name()
  load_settings()
  is_uninstall_allowed()
  get_manage_url()
  get_uninstall_extra_warning()
  uninstall_cleanup()


Class: block  - X-Ref

Class for page side blocks

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($name)   X-Ref
Magic method getter, redirects to read only values.

For block plugins pretends the object has 'visible' property for compatibility
with plugins developed for Moodle version below 2.4

param: string $name
return: mixed

init_display_name()   X-Ref
No description

get_settings_section_name()   X-Ref
No description

load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig)   X-Ref
No description

is_uninstall_allowed()   X-Ref
No description

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

return: moodle_url

get_uninstall_extra_warning()   X-Ref
Warning with number of block instances.

return: string

uninstall_cleanup()   X-Ref
Pre-uninstall hook.

This is intended for disabling of plugin, some DB table purging, etc.

NOTE: to be called from uninstall_plugin() only.