From a4e9d09d35785d2b4357c20eb38905c9d97cff2b Mon Sep 17 00:00:00 2001
From: Jennifer Hodgdon <yahgrp@poplarware.com>
Date: Tue, 4 Mar 2014 08:35:13 -0800
Subject: [PATCH] Issue #2208649 by joachim, Crell: Improve documentation of
queue hook by defining a callback function template
---
core/modules/system/system.api.php | 27 ++++++++++++++++++++++++---
1 file changed, 24 insertions(+), 3 deletions(-)
diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php
index b830cdee1e2f..225a4fa5f019 100644
--- a/core/modules/system/system.api.php
+++ b/core/modules/system/system.api.php
@@ -158,9 +158,8 @@ function hook_data_type_info_alter(&$data_types) {
* @return
* An associative array where the key is the queue name and the value is
* again an associative array. Possible keys are:
- * - 'worker callback': A PHP callable to call. It will be called
- * with one argument, the item created via
- * \Drupal\Core\Queue\QueueInterface::createItem().
+ * - 'worker callback': A PHP callable to call that is an implementation of
+ * callback_queue_worker().
* - 'cron': (optional) An associative array containing the optional key:
* - 'time': (optional) How much time Drupal cron should spend on calling
* this worker in seconds. Defaults to 15.
@@ -200,6 +199,28 @@ function hook_queue_info_alter(&$queues) {
$queues['aggregator_feeds']['cron']['time'] = 90;
}
+/**
+ * Work on a single queue item.
+ *
+ * Callback for hook_queue_info().
+ *
+ * @param $queue_item_data
+ * The data that was passed to \Drupal\Core\Queue\QueueInterface::createItem()
+ * when the item was queued.
+ *
+ * @throws \Exception
+ * The worker callback may throw an exception to indicate there was a problem.
+ * The cron process will log the exception, and leave the item in the queue to
+ * be processed again later.
+ *
+ * @see \Drupal\Core\Cron::run()
+ */
+function callback_queue_worker($queue_item_data) {
+ $node = node_load($queue_item_data);
+ $node->title = 'Updated title';
+ $node->save();
+}
+
/**
* Allows modules to declare their own Form API element types and specify their
* default values.
--
GitLab