Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Drupal.php

function Drupal::queue

Returns a queue for the given queue name.

The following values can be set in your settings.php file's $settings array to define which services are used for queues:

  • queue_reliable_service_$name: The container service to use for the reliable queue $name.
  • queue_service_$name: The container service to use for the queue $name.
  • queue_default: The container service to use by default for queues without overrides. This defaults to 'queue.database'.

Parameters

string $name: The name of the queue to work with.

bool $reliable: (optional) TRUE if the ordering of items and guaranteeing every item executes at least once is important, FALSE if scalability is the main concern. Defaults to FALSE.

Return value

\Drupal\Core\Queue\QueueInterface The queue object for a given name.

4 calls to Drupal::queue()
hook_cron in core/core.api.php
Perform periodic actions.
locale_cron_fill_queue in core/modules/locale/locale.translation.inc
Populate a queue with project to check for translation updates.
update_install in core/modules/update/update.install
Implements hook_install().
update_uninstall in core/modules/update/update.install
Implements hook_uninstall().

File

core/lib/Drupal.php, line 453

Class

Drupal
Static Service Container wrapper.

Code

public static function queue($name, $reliable = FALSE) {
    return static::getContainer()->get('queue')
        ->get($name, $reliable);
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal