Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Class: external  - X-Ref

This class contains a list of webservice functions related to output.

load_template_parameters()   X-Ref
Returns description of load_template() parameters.

return: external_function_parameters

load_template($component, $template, $themename, $includecomments = false)   X-Ref
Return a mustache template, and all the strings it requires.

param: string $component The component that holds the template.
param: string $templatename The name of the template.
param: string $themename The name of the current theme.
return: string the template

load_template_returns()   X-Ref
Returns description of load_template() result value.

return: \core_external\external_description

load_template_with_dependencies_parameters()   X-Ref
Returns description of load_template_with_dependencies() parameters.

return: external_function_parameters

load_template_with_dependencies(string $component,string $template,string $themename,bool $includecomments = false,string $lang = null)   X-Ref
Return a mustache template, and all the child templates and strings it requires.

param: string $component The component that holds the template.
param: string $template The name of the template.
param: string $themename The name of the current theme.
param: bool $includecomments Whether to strip comments from the template source.
param: string $lang moodle translation language, null means use current.
return: string the template

load_template_with_dependencies_returns()   X-Ref
Returns description of load_template_with_dependencies() result value.

return: \core_external\external_description

load_fontawesome_icon_map_parameters()   X-Ref
Returns description of load_icon_map() parameters.

return: external_function_parameters

load_fontawesome_icon_map()   X-Ref
Return a mapping of icon names to icons.

return: array the mapping

load_fontawesome_icon_map_returns()   X-Ref
Returns description of load_icon_map() result value.

return: \core_external\external_description

load_fontawesome_icon_map_is_deprecated()   X-Ref
The `load_fontawesome_icon_map` function has been replaced with

return: bool