Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
core_block

Topics

 external
 
 
 navigation
 
 
 test
 
 

Namespaces

namespace  core_block\external
  
 
namespace  core_block\privacy
 Data provider.
 

Classes

class  block_base
 Class for describing a moodle block, all Moodle blocks derive from this class. More...
 
class  block_edit_form
 Defines the base class form used by blocks/edit.php to edit block instance configuration. More...
 
class  block_list
 Specialized class for displaying a block with a list of icons/text labels. More...
 
class  block_tree
 Specialized class for displaying a tree menu. More...
 
class  core_block\external\fetch_addable_blocks
 This is the external method used for fetching the addable blocks in a given page. More...
 
class  core_block\privacy\provider
 Data provider class. More...
 

Variables

const BLOCK_TYPE_LIST 1
 This file contains the parent class for moodle blocks, block_base.
 
const BLOCK_TYPE_TEXT 2
 Block type of text.
 
const BLOCK_TYPE_TREE 3
 Block type of tree.
 

Detailed Description

Variable Documentation

◆ BLOCK_TYPE_LIST

const BLOCK_TYPE_LIST 1

This file contains the parent class for moodle blocks, block_base.

License
http://www.gnu.org/copyleft/gpl.html GNU Public License Constants Block type of list. Contents of block should be set as an associative array in the content object as items ($this->content->items). Optionally include footer text in $this->content->footer.

◆ BLOCK_TYPE_TEXT

const BLOCK_TYPE_TEXT 2

Block type of text.

Contents of block should be set to standard html text in the content object as items ($this->content->text). Optionally include footer text in $this->content->footer.

◆ BLOCK_TYPE_TREE

const BLOCK_TYPE_TREE 3

Block type of tree.

$this->content->items is a list of tree_item objects and $this->content->footer is a string.