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.

Differences Between: [Versions 311 and 402] [Versions 400 and 402] [Versions 401 and 402]

(no description)

File Size: 131 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

fetch_addable_blocks:: (3 methods):
  execute_parameters()
  execute()
  execute_returns()


Class: fetch_addable_blocks  - X-Ref

This is the external method used for fetching the addable blocks in a given page.

execute_parameters()   X-Ref
Describes the parameters for execute.

return: external_function_parameters

execute(int $pagecontextid, string $pagetype, string $pagelayout,string $subpage = '', string $pagehash = '')   X-Ref
Fetch the addable blocks in a given page.

param: int $pagecontextid The context ID of the page
param: string $pagetype The type of the page
param: string $pagelayout The layout of the page
param: string $subpage The subpage identifier
param: string $pagehash Page hash that can be provided instead of all parameters above
return: array The blocks list

execute_returns()   X-Ref
Describes the execute return value.

return: external_multiple_structure