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

(no description)

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

Defines 1 class


Class: core_tag_external  - X-Ref

Tags-related web services

update_tags_parameters()   X-Ref
Parameters for function update_tags()

return: external_function_parameters

update_tags($tags)   X-Ref
Update tags

param: array $tags

update_tags_returns()   X-Ref
Return structure for update_tag()

return: \core_external\external_description

get_tags_parameters()   X-Ref
Parameters for function get_tags()

return: external_function_parameters

get_tags($tags)   X-Ref
Get tags by their ids

param: array $tags

get_tags_returns()   X-Ref
Return structure for get_tag()

return: \core_external\external_description

get_tagindex_parameters()   X-Ref
Parameters for function get_tagindex()

return: external_function_parameters

get_tagindex($params)   X-Ref
Get tags by their ids

param: array $params

get_tagindex_returns()   X-Ref
Return structure for get_tag()

return: \core_external\external_description

get_tagindex_per_area_parameters()   X-Ref
Parameters for function get_tagindex_per_area()

return: external_function_parameters

get_tagindex_per_area($params)   X-Ref
Returns the tag index per multiple areas if requested.

param: array $params Tag index required information.

get_tagindex_per_area_returns()   X-Ref
Return structure for get_tagindex_per_area

return: \core_external\external_description

get_tag_areas_parameters()   X-Ref
Returns description of get_tag_areas() parameters.

return: external_function_parameters

get_tag_areas()   X-Ref
Retrieves existing tag areas.

return: array an array of warnings and objects containing the plugin information

get_tag_areas_returns()   X-Ref
Returns description of get_tag_areas() result value.

return: \core_external\external_description

get_tag_collections_parameters()   X-Ref
Returns description of get_tag_collections() parameters.

return: external_function_parameters

get_tag_collections()   X-Ref
Retrieves existing tag collections.

return: array an array of warnings and tag collections

get_tag_collections_returns()   X-Ref
Returns description of get_tag_collections() result value.

return: \core_external\external_description

get_tag_cloud_parameters()   X-Ref
Returns description of get_tag_cloud() parameters.

return: external_function_parameters

get_tag_cloud($tagcollid = 0, $isstandard = false, $limit = 150, $sort = 'name',$search = '', $fromctx = 0, $ctx = 0, $rec = 1)   X-Ref
Retrieves a tag cloud for display.

param: int $tagcollid tag collection id
param: bool $isstandard return only standard tags
param: int $limit maximum number of tags to retrieve, tags are sorted by the instance count
param: string $sort sort order for display, default 'name' - tags will be sorted after they are retrieved
param: string $search search string
param: int $fromctx context id where this tag cloud is displayed
param: int $ctx only retrieve tag instances in this context
param: int $rec retrieve tag instances in the $ctx context and it's children (default 1)
return: array an array of warnings and tag cloud information and items

get_tag_cloud_returns()   X-Ref
Returns description of get_tag_cloud() result value.

return: \core_external\external_description