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.

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

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

Copyright: 2020 Mihail Geshoski <mihail@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 123 lines (4 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 = '')   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
return: array The blocks list

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

return: external_multiple_structure