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.
/blocks/settings/ -> block_settings.php (source)

[Source view]

Differences Between: [Versions 402 and 403]

This file contains classes used to manage the navigation structures in Moodle and was introduced as part of the changes occuring in Moodle 2.0

Copyright: 2009 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 178 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

block_settings:: (10 methods):
  init()
  instance_allow_multiple()
  instance_can_be_hidden()
  applicable_formats()
  instance_allow_config()
  instance_can_be_docked()
  get_required_javascript()
  get_content()
  get_aria_role()
  get_config_for_external()


Class: block_settings  - X-Ref

The settings navigation tree block class

Used to produce the settings navigation block new to Moodle 2.0

init()   X-Ref
Set the initial properties for the block


instance_allow_multiple()   X-Ref
All multiple instances of this block

return: bool Returns true

instance_can_be_hidden()   X-Ref
The settings block cannot be hidden by default as it is integral to
the navigation of Moodle.

return: false

applicable_formats()   X-Ref
Set the applicable formats for this block to all

return: array

instance_allow_config()   X-Ref
Allow the user to configure a block instance

return: bool Returns true

instance_can_be_docked()   X-Ref
No description

get_required_javascript()   X-Ref
No description

get_content()   X-Ref
Gets the content for this block by grabbing it from $this->page


get_aria_role()   X-Ref
Returns the role that best describes the settings block.

return: string 'navigation'

get_config_for_external()   X-Ref
Return the plugin config settings for external functions.

return: stdClass the configs for both the block instance and plugin