function QueueInterface::createItem

Same name in other branches
  1. 9 core/lib/Drupal/Core/Queue/QueueInterface.php \Drupal\Core\Queue\QueueInterface::createItem()
  2. 10 core/lib/Drupal/Core/Queue/QueueInterface.php \Drupal\Core\Queue\QueueInterface::createItem()
  3. 11.x core/lib/Drupal/Core/Queue/QueueInterface.php \Drupal\Core\Queue\QueueInterface::createItem()

Adds a queue item and store it directly to the queue.

Parameters

$data: Arbitrary data to be associated with the new task in the queue.

Return value

A unique ID if the item was successfully created and was (best effort) added to the queue, otherwise FALSE. We don't guarantee the item was committed to disk etc, but as far as we know, the item is now in the queue.

1 method overrides QueueInterface::createItem()
Memory::createItem in core/lib/Drupal/Core/Queue/Memory.php
Adds a queue item and store it directly to the queue.

File

core/lib/Drupal/Core/Queue/QueueInterface.php, line 27

Class

QueueInterface
Interface for a queue.

Namespace

Drupal\Core\Queue

Code

public function createItem($data);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.