aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cron/task/task.php
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/cron/task/task.php')
-rw-r--r--phpBB/includes/cron/task/task.php9
1 files changed, 9 insertions, 0 deletions
diff --git a/phpBB/includes/cron/task/task.php b/phpBB/includes/cron/task/task.php
index 72fda91dd0..58c4a96f8e 100644
--- a/phpBB/includes/cron/task/task.php
+++ b/phpBB/includes/cron/task/task.php
@@ -49,6 +49,15 @@ interface phpbb_cron_task
/**
* Returns whether this cron task can be run in shutdown function.
*
+ * By the time shutdown sequence invokes a particular piece of code,
+ * resources that that code requires may already be released.
+ * If so, a particular cron task may be marked shutdown function-
+ * unsafe, and it will be executed in normal program flow.
+ *
+ * Generally speaking cron tasks should start off as shutdown function-
+ * safe, and only be marked shutdown function-unsafe if a problem
+ * is discovered.
+ *
* @return bool
*/
public function is_shutdown_function_safe();