Issue #604902 by rschwab, drewish: Add documentation about Batch API success parameter.

merge-requests/26/head
webchick 2011-06-01 01:39:32 -07:00
parent 14d2ba86be
commit 6fc37ebf29
1 changed files with 2 additions and 0 deletions

View File

@ -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.');
* }