aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/cron/task/base.php
diff options
context:
space:
mode:
Diffstat (limited to 'phpBB/includes/cron/task/base.php')
-rw-r--r--phpBB/includes/cron/task/base.php11
1 files changed, 10 insertions, 1 deletions
diff --git a/phpBB/includes/cron/task/base.php b/phpBB/includes/cron/task/base.php
index a4e89f137f..38c0b844d9 100644
--- a/phpBB/includes/cron/task/base.php
+++ b/phpBB/includes/cron/task/base.php
@@ -55,7 +55,16 @@ abstract class phpbb_cron_task_base implements phpbb_cron_task
/**
* Returns whether this cron task can be run in shutdown function.
*
- * @return bool
+ * 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 Whether the cron task is shutdown function-safe.
*/
public function is_shutdown_function_safe()
{