Home > Developer Guide > Hooks > Queue Hooks

hook_civicrm_QueueRun

Summary

Fire hook_civicrm_queueRun_{$runner}.

Description

This event only fires if these conditions are met:

1. The $queue has been persisted in civicrm_queue.
2. The $queue has a runner property.
3. The $queue has some pending tasks.
4. The system has a queue-running agent.

Definition

hook_civicrm_QueueRun(CRM_Queue_Queue $queue, array $items, &$outcomes) { : void

Parameters

• @param CRM_Queue_Queue $queue

• @param array $items List of claimed items which we may evaluate.

• @param array $outcomes The outcomes of each task. One of 'ok', 'retry', 'fail'. Keys should match the keys in $items.

Availability

5.51+

Example