Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_block\external\fetch_addable_blocks Class Reference
Inheritance diagram for core_block\external\fetch_addable_blocks:

Static Public Member Functions

static execute (int $pagecontextid, string $pagetype, string $pagelayout, string $subpage='', string $pagehash='')
 Fetch the addable blocks in a given page.
 
static execute_parameters ()
 Describes the parameters for execute.
 
static execute_returns ()
 Describes the execute return value.
 

Member Function Documentation

◆ execute()

static core_block\external\fetch_addable_blocks::execute ( int $pagecontextid,
string $pagetype,
string $pagelayout,
string $subpage = '',
string $pagehash = '' )
static

Fetch the addable blocks in a given page.

Parameters
int$pagecontextidThe context ID of the page
string$pagetypeThe type of the page
string$pagelayoutThe layout of the page
string$subpageThe subpage identifier
string$pagehashPage hash that can be provided instead of all parameters above
Return values
arrayThe blocks list

◆ execute_parameters()

static core_block\external\fetch_addable_blocks::execute_parameters ( )
static

Describes the parameters for execute.

Return values
external_function_parameters

◆ execute_returns()

static core_block\external\fetch_addable_blocks::execute_returns ( )
static

Describes the execute return value.

Return values
external_multiple_structure

The documentation for this class was generated from the following file: