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

[Source view]

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

This is the external API for blogs.

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

Defines 1 class

external:: (7 methods):
  validate_access_and_filters()
  get_entries_parameters()
  get_entries()
  get_entries_returns()
  view_entries_parameters()
  view_entries()
  view_entries_returns()


Class: external  - X-Ref

This is the external API for blogs.

validate_access_and_filters($rawwsfilters)   X-Ref
Validate access to the blog and the filters to apply when listing entries.

param: array  $rawwsfilters array containing the filters in WS format
return: array  context, filters to apply and the calculated courseid and user

get_entries_parameters()   X-Ref
Returns description of get_entries() parameters.

return: external_function_parameters

get_entries($filters = array()   X-Ref
Return blog entries.

param: array $filters the parameters to filter the blog listing
param: int $page the blog page to return
param: int $perpage the number of posts to return per page
return: array with the blog entries and warnings

get_entries_returns()   X-Ref
Returns description of get_entries() result value.

return: external_description

view_entries_parameters()   X-Ref
Returns description of view_entries() parameters.

return: external_function_parameters

view_entries($filters = array()   X-Ref
Trigger the blog_entries_viewed event.

param: array $filters the parameters used in the filter of get_entries
return: array with status result and warnings

view_entries_returns()   X-Ref
Returns description of view_entries() result value.

return: external_description