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.
/lib/classes/task/ -> messaging_cleanup_task.php (source)

[Source view]

A scheduled task.

Copyright: 2013 onwards Martin Dougiamas http://dougiamas.com
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 77 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

messaging_cleanup_task:: (2 methods):
  get_name()
  execute()


Class: messaging_cleanup_task  - X-Ref

Simple task to delete old messaging records.

get_name()   X-Ref
Get a descriptive name for this task (shown to admins).

return: string

execute()   X-Ref
Do the job. Each message processor also gets the chance to perform it's own cleanup.
Throw exceptions on errors (the job will be retried).