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/ -> filter.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: 182 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

filter:: (9 methods):
  init_display_name()
  get_enabled_plugins()
  enable_plugin()
  get_enabled_plugin()
  get_settings_section_name()
  load_settings()
  is_uninstall_allowed()
  get_manage_url()
  uninstall_cleanup()


Class: filter  - X-Ref

Class for text filters

init_display_name()   X-Ref
No description

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
Enable or disable a plugin.
When possible, the change will be stored into the config_log table, to let admins check when/who has modified it.

param: string $pluginname The plugin name to enable/disable.
param: int $enabled Whether the pluginname should be TEXTFILTER_ON, TEXTFILTER_OFF or TEXTFILTER_DISABLED.
return: bool It always return true because we don't know if the value has changed or not. That way, we guarantee any action

get_enabled_plugin(string $pluginname)   X-Ref
Returns current status for a pluginname.

Filters have different values for enabled/disabled plugins so the current value needs to be calculated in a
different way than the default method in the base class.

param: string $pluginname The plugin name to check.
return: int The current status (enabled, disabled...) of $pluginname.

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

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.