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 310 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]

External interface library for customfields component

Copyright: 2018 David Matamoros <davidmc@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 295 lines (11 kb)
Included or required:0 times
Referenced: 6 times
Includes or requires: 0 files

Defines 1 class


Class: core_customfield_external  - X-Ref

Class core_customfield_external

delete_field_parameters()   X-Ref
Parameters for delete_field

return: external_function_parameters

delete_field($id)   X-Ref
Delete custom field function

param: int $id

delete_field_returns()   X-Ref
Return for delete_field


reload_template_parameters()   X-Ref
Parameters for reload template function

return: external_function_parameters

reload_template($component, $area, $itemid)   X-Ref
Reload template function

param: string $component
param: string $area
param: int $itemid
return: array|object|stdClass

reload_template_returns()   X-Ref
Ajax returns on reload template.

return: external_single_structure

delete_category_parameters()   X-Ref
Parameters for delete category

return: external_function_parameters

delete_category($id)   X-Ref
Delete category function

param: int $id

delete_category_returns()   X-Ref
Return for delete category


create_category_parameters()   X-Ref
Parameters for create category

return: external_function_parameters

create_category($component, $area, $itemid)   X-Ref
Create category function

param: string $component
param: string $area
param: int    $itemid
return: mixed

create_category_returns()   X-Ref
Return for create category


move_field_parameters()   X-Ref
Parameters for move field.

return: external_function_parameters

move_field($id, $categoryid, $beforeid)   X-Ref
Move/reorder field. Move a field to another category and/or change sortorder of fields

param: int $id field id
param: int $categoryid
param: int $beforeid

move_field_returns()   X-Ref
Return for move field


move_category_parameters()   X-Ref
Return for move category

return: external_function_parameters

move_category(int $id, int $beforeid)   X-Ref
Reorder categories. Move category to the new position

param: int $id category id
param: int $beforeid

move_category_returns()   X-Ref
Return for move category