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.
/filter/classes/ -> external.php (source)

[Source view]

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

This is the external API for the filter component.

Copyright: 2017 Juan Leyva
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 134 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

external:: (3 methods):
  get_available_in_context_parameters()
  get_available_in_context()
  get_available_in_context_returns()


Class: external  - X-Ref

This is the external API for the filter component.

get_available_in_context_parameters()   X-Ref
Returns description of get_available_in_context() parameters.

return: external_function_parameters

get_available_in_context($contexts)   X-Ref
Returns the filters available in the given contexts.

param: array $contexts the list of contexts to check
return: array with the filters information and warnings

get_available_in_context_returns()   X-Ref
Returns description of get_available_in_context() result value.

return: external_single_structure