diff options
| author | webchick <webchick@24967.no-reply.drupal.org> | 2011-06-01 01:39:32 -0700 |
|---|---|---|
| committer | webchick <webchick@24967.no-reply.drupal.org> | 2011-06-01 01:39:32 -0700 |
| commit | 6fc37ebf29806208f58c5790430ce798fecdff89 (patch) | |
| tree | 3d8aba03f200a9f5a6c93e8e88d27c434002a09c /includes | |
| parent | 14d2ba86befdbdbaaf34c9be642e60ff78bfccc7 (diff) | |
| download | brdo-6fc37ebf29806208f58c5790430ce798fecdff89.tar.gz brdo-6fc37ebf29806208f58c5790430ce798fecdff89.tar.bz2 | |
Issue #604902 by rschwab, drewish: Add documentation about Batch API success parameter.
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/form.inc | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/includes/form.inc b/includes/form.inc index a337b03d1..b024918a3 100644 --- a/includes/form.inc +++ b/includes/form.inc @@ -4074,6 +4074,8 @@ function _form_set_class(&$element, $class = array()) { * Sample 'finished' callback: * @code * function batch_test_finished($success, $results, $operations) { + * // The 'success' parameter means no fatal PHP errors were detected. All + * // other error management should be handled using 'results'. * if ($success) { * $message = format_plural(count($results), 'One post processed.', '@count posts processed.'); * } |