The Queue API in Drupal allows us to handle a number of tasks at a later stage. What this means is that we can place items into a queue which will run some time in the future and process each individual item at that point and at least once. Usually, this happens on CRON runs, and Drupal 8 allows for a quick set up for cronjob based queues. It doesn’t necessarily have to be CRON, however.
In this article, we will look at using the Queue API in Drupal 8 by exploring two simple examples. The first will see the queue triggered by Cron while the second will allow us to manually do so ourselves. However, the actual processing will be handled by a similar worker. If you want to follow along, clone this git repository where you can find the npq module we will write in this article.
The module we’ll work with is called Node Publisher Queue and it automatically adds newly created nodes that are saved unpublished to a queue to be published later on. We will see how later on can be the next CRON run or a manual action triggered by the site’s administrator. First, let’s understand some basic concepts about queues in Drupal 8.
The theory
There are a few components that make up the Queue API in Drupal 8.
The most important role in this API is played by the QueueInterface implementation which represents the queue. The default queue type Drupal 8 ships with is currently the DatabaseQueue which is a type of reliable queue that makes sure all its items are processed at least once and in their original order (FIFO). This is in contrast to unreliable queues which only do their best to achieve this (something for which valid use cases do exist).
The typical role of the queue object is to create items, later claim them from the queue and delete them when they have been processed. In addition, it can release items if processing is either not finished or another worker needs to process them again before deletion.
The QueueInterface implementation is instantiated with the help of a general QueueFactory. In the case of the DatabaseQueue, the former uses the DatabaseQueueFactory as well. Queues also need to be created before they can be used. However, the DatabaseQueue is already created when Drupal is first installed so no additional setup is required.
The Queue Workers are responsible for processing queue items as they receive them. In Drupal 8 these are QueueWorker plugins that implement the QueueWorkerInterface. Using the QueueWorkerManager, we create instances of these plugins and process the items whenever the queue needs to be run.
Queue item creation
Inside the npq.module file we take care of the logic for creating queue items whenever a node is saved and not published:
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Queue\QueueFactory;
use Drupal\Core\Queue\QueueInterface;
/**
* Implements hook_entity_insert().
*/
function npq_entity_insert(EntityInterface $entity) {
if ($entity->getEntityTypeId() !== 'node') {
return;
}
if ($entity->isPublished()) {
return;
}
/** @var QueueFactory $queue_factory */
$queue_factory = \Drupal::service('queue');
/** @var QueueInterface $queue */
$queue = $queue_factory->get('cron_node_publisher');
$item = new \stdClass();
$item->nid = $entity->id();
$queue->createItem($item);
}
Inside this basic hook_entity_insert() implementation we do a very simple task. We first retrieve the QueueFactoryInterface object from the service container and use it to get a queue called cron_node_publisher. If we track things down, we notice that the get() method on the DatabaseQueueFactory simply creates a new DatabaseQueue instance with the name we pass to it.
Learn More 4001
Learn More 4002
Learn More 4003
Learn More 4004
Learn More 4005
Learn More 4006
Learn More 4007
Learn More 4008
Learn More 4009
Learn More 4010
Learn More 4011
Learn More 4012
Learn More 4013
Learn More 4014
Learn More 4015
Learn More 4016
Learn More 4017
Learn More 4018
Learn More 4019
Learn More 4020
Learn More 4021
Learn More 4022
Learn More 4023
Learn More 4024
Learn More 4025
Learn More 4026
Learn More 4027
Learn More 4028
Learn More 4029
Learn More 4030
Learn More 4031
Learn More 4032
Learn More 4033
Learn More 4034
Learn More 4035
Learn More 4036
Learn More 4037
Learn More 4038
Learn More 4039
Learn More 4040
Learn More 4041
Learn More 4042
Learn More 4043
Learn More 4044
Learn More 4045
Learn More 4046
Learn More 4047
Learn More 4048
Learn More 4049
Learn More 4050
Learn More 4051
Learn More 4052
Learn More 4053
Learn More 4054
Learn More 4055
Learn More 4056
Learn More 4057
Learn More 4058
Learn More 4059
Learn More 4060
Learn More 4061
Learn More 4062
Learn More 4063
Learn More 4064
Learn More 4065
Learn More 4066
Learn More 4067
Learn More 4068
Learn More 4069
Learn More 4070
Learn More 4071
Learn More 4072
Learn More 4073
Learn More 4074
Learn More 4075
Learn More 4076
Learn More 4077
Learn More 4078
Learn More 4079
Learn More 4080
Learn More 4081
Learn More 4082
Learn More 4083
Learn More 4084
Learn More 4085
Learn More 4086
Learn More 4087
Learn More 4088
Learn More 4089
Learn More 4090
Learn More 4091
Learn More 4092
Learn More 4093
Learn More 4094
Learn More 4095
Learn More 4096
Learn More 4097
Learn More 4098
Learn More 4099
Learn More 4100
Learn More 4101
Learn More 4102
Learn More 4103
Learn More 4104
Learn More 4105
Learn More 4106
Learn More 4107
Learn More 4108
Learn More 4109
Learn More 4110
Learn More 4111
Learn More 4112
Learn More 4113
Learn More 4114
Learn More 4115
Learn More 4116
Learn More 4117
Learn More 4118
Learn More 4119
Learn More 4120
Learn More 4121
Learn More 4122
Learn More 4123
Learn More 4124
Learn More 4125
Learn More 4126
Learn More 4127
Learn More 4128
Learn More 4129
Learn More 4130
Learn More 4131
Learn More 4132
Learn More 4133
Learn More 4134
Learn More 4135
Learn More 4136
Learn More 4137
Learn More 4138
Learn More 4139
Learn More 4140
Learn More 4141
Learn More 4142
Learn More 4143
Learn More 4144
Learn More 4145
Learn More 4146
Learn More 4147
Learn More 4148
Learn More 4149
Learn More 4150
Learn More 4151
Learn More 4152
Learn More 4153
Learn More 4154
Learn More 4155
Learn More 4156
Learn More 4157
Learn More 4158
Learn More 4159
Learn More 4160
Learn More 4161
Learn More 4162
Learn More 4163
Learn More 4164
Learn More 4165
Learn More 4166
Learn More 4167
Learn More 4168
Learn More 4169
Learn More 4170
Learn More 4171
Learn More 4172
Learn More 4173
Learn More 4174
Learn More 4175
Learn More 4176
Learn More 4177
Learn More 4178
Learn More 4179
Learn More 4180
Learn More 4181
Learn More 4182
Learn More 4183
Learn More 4184
Learn More 4185
Learn More 4186
Learn More 4187
Learn More 4188
Learn More 4189
Learn More 4190
Learn More 4191
Learn More 4192
Learn More 4193
Learn More 4194
Learn More 4195
Learn More 4196
Learn More 4197
Learn More 4198
Learn More 4199
Learn More 4200
Learn More 4201
Learn More 4202
Learn More 4203
Learn More 4204
Learn More 4205
Learn More 4206
Learn More 4207
Learn More 4208
Learn More 4209
Learn More 4210
Learn More 4211
Learn More 4212
Learn More 4213
Learn More 4214
Learn More 4215
Learn More 4216
Learn More 4217
Learn More 4218
Learn More 4219
Learn More 4220
Learn More 4221
Learn More 4222
Learn More 4223
Learn More 4224
Learn More 4225
Learn More 4226
Learn More 4227
Learn More 4228
Learn More 4229
Learn More 4230
Learn More 4231
Learn More 4232
Learn More 4233
Learn More 4234
Learn More 4235
Learn More 4236
Learn More 4237
Learn More 4238
Learn More 4239
Learn More 4240
Learn More 4241
Learn More 4242
Learn More 4243
Learn More 4244
Learn More 4245
Learn More 4246
Learn More 4247
Learn More 4248
Learn More 4249
Learn More 4250
Learn More 4251
Learn More 4252
Learn More 4253
Learn More 4254
Learn More 4255
Learn More 4256
Learn More 4257
Learn More 4258
Learn More 4259
Learn More 4260
Learn More 4261
Learn More 4262
Learn More 4263
Learn More 4264
Learn More 4265
Learn More 4266
Learn More 4267
Learn More 4268
Learn More 4269
Learn More 4270
Learn More 4271
Learn More 4272
Learn More 4273
Learn More 4274
Learn More 4275
Learn More 4276
Learn More 4277
Learn More 4278
Learn More 4279
Learn More 4280
Learn More 4281
Learn More 4282
Learn More 4283
Learn More 4284
Learn More 4285
Learn More 4286
Learn More 4287
Learn More 4288
Learn More 4289
Learn More 4290
Learn More 4291
Learn More 4292
Learn More 4293
Learn More 4294
Learn More 4295
Learn More 4296
Learn More 4297
Learn More 4298
Learn More 4299
Learn More 4300
Learn More 4301
Learn More 4302
Learn More 4303
Learn More 4304
Learn More 4305
Learn More 4306
Learn More 4307
Learn More 4308
Learn More 4309
Learn More 4310
Learn More 4311
Learn More 4312
Learn More 4313
Learn More 4314
Learn More 4315
Learn More 4316
Learn More 4317
Learn More 4318
Learn More 4319
Learn More 4320
Learn More 4321
Learn More 4322
Learn More 4323
Learn More 4324
Learn More 4325
Learn More 4326
Learn More 4327
Learn More 4328
Learn More 4329
Learn More 4330
Learn More 4331
Learn More 4332
Learn More 4333
Learn More 4334
Learn More 4335
Learn More 4336
Learn More 4337
Learn More 4338
Learn More 4339
Learn More 4340
Learn More 4341
Learn More 4342
Learn More 4343
Learn More 4344
Learn More 4345
Learn More 4346
Learn More 4347
Learn More 4348
Learn More 4349
Learn More 4350
Learn More 4351
Learn More 4352
Learn More 4353
Learn More 4354
Learn More 4355
Learn More 4356
Learn More 4357
Learn More 4358
Learn More 4359
Learn More 4360
Learn More 4361
Learn More 4362
Learn More 4363
Learn More 4364
Learn More 4365
Learn More 4366
Learn More 4367
Learn More 4368
Learn More 4369
Learn More 4370
Learn More 4371
Learn More 4372
Learn More 4373
Learn More 4374
Learn More 4375
Learn More 4376
Learn More 4377
Learn More 4378
Learn More 4379
Learn More 4380
Learn More 4381
Learn More 4382
Learn More 4383
Learn More 4384
Learn More 4385
Learn More 4386
Learn More 4387
Learn More 4388
Learn More 4389
Learn More 4390
Learn More 4391
Learn More 4392
Learn More 4393
Learn More 4394
Learn More 4395
Learn More 4396
Learn More 4397
Learn More 4398
Learn More 4399
Learn More 4400
Learn More 4401
Learn More 4402
Learn More 4403
Learn More 4404
Learn More 4405
Learn More 4406
Learn More 4407
Learn More 4408
Learn More 4409
Learn More 4410
Learn More 4411
Learn More 4412
Learn More 4413
Learn More 4414
Learn More 4415
Learn More 4416
Learn More 4417
Learn More 4418
Learn More 4419
Learn More 4420
Learn More 4421
Learn More 4422
Learn More 4423
Learn More 4424
Learn More 4425
Learn More 4426
Learn More 4427
Learn More 4428
Learn More 4429
Learn More 4430
Learn More 4431
Learn More 4432
Learn More 4433
Learn More 4434
Learn More 4435
Learn More 4436
Learn More 4437
Learn More 4438
Learn More 4439
Learn More 4440
Learn More 4441
Learn More 4442
Learn More 4443
Learn More 4444
Learn More 4445
Learn More 4446
Learn More 4447
Learn More 4448
Learn More 4449
Learn More 4450
Learn More 4451
Learn More 4452
Learn More 4453
Learn More 4454
Learn More 4455
Learn More 4456
Learn More 4457
Learn More 4458
Learn More 4459
Learn More 4460
Learn More 4461
Learn More 4462
Learn More 4463
Learn More 4464
Learn More 4465
Learn More 4466
Learn More 4467
Learn More 4468
Learn More 4469
Learn More 4470
Learn More 4471
Learn More 4472
Learn More 4473
Learn More 4474
Learn More 4475
Learn More 4476
Learn More 4477
Learn More 4478
Learn More 4479
Learn More 4480
Learn More 4481
Learn More 4482
Learn More 4483
Learn More 4484
Learn More 4485
Learn More 4486
Learn More 4487
Learn More 4488
Learn More 4489
Learn More 4490
Learn More 4491
Learn More 4492
Learn More 4493
Learn More 4494
Learn More 4495
Learn More 4496
Learn More 4497
Learn More 4498
Learn More 4499
Learn More 4500
