PHP AMQPQueue::purge() Method: Usage and Examples

The PHP AMQPQueue::purge API performs a focused operation on an object or value. The examples below show its effect on actual data.

Removes queued messages without deleting the queue itself.

What Is AMQPQueue::purge in PHP?

Removes queued messages without deleting the queue itself.

This API requires a relevant extension or PHP version and cannot be reflected in the local PHP 8.4 runtime. Refer to the version or extension note below before using the examples.

Compatibility note: Install the PECL AMQP extension and configure a RabbitMQ-compatible broker before running this example.

Example 1: Basic Usage

This example uses a small input to make the main behavior visible.

<?php

$connection = new AMQPConnection([
    "host" => getenv("AMQP_HOST") ?: "127.0.0.1",
    "port" => 5672,
    "login" => getenv("AMQP_USERNAME") ?: "guest",
    "password" => getenv("AMQP_PASSWORD") ?: "guest"
]);
$connection->connect();
$channel = new AMQPChannel($connection);
$exchange = new AMQPExchange($channel);
$exchange->setName("events.exchange");
$exchange->setType(AMQP_EX_TYPE_DIRECT);
$exchange->declareExchange();
$queue = new AMQPQueue($channel);
$queue->setName("events.queue");
$queue->declareQueue();
$removedCount = $queue->purge();
echo $removedCount;
$connection->disconnect();

Removes queued messages without deleting the queue itself.

Example 2: A Different Input

A different set of values shows the same operation in another situation.

<?php

$connection = new AMQPConnection([
    "host" => getenv("AMQP_HOST") ?: "127.0.0.1",
    "port" => 5672,
    "login" => getenv("AMQP_USERNAME") ?: "guest",
    "password" => getenv("AMQP_PASSWORD") ?: "guest"
]);
$connection->connect();
$channel = new AMQPChannel($connection);
$exchange = new AMQPExchange($channel);
$exchange->setName("audit.exchange");
$exchange->setType(AMQP_EX_TYPE_DIRECT);
$exchange->declareExchange();
$queue = new AMQPQueue($channel);
$queue->setName("audit.queue");
$queue->declareQueue();
$removedCount = $queue->purge();
echo $removedCount;
$connection->disconnect();

This discards queued messages and should be reserved for intentional maintenance.

Practical Example: Applying the Feature

This example shows an application-style use of the feature, with its surrounding setup visible.

<?php

$connection = new AMQPConnection([
    "host" => getenv("AMQP_HOST") ?: "127.0.0.1",
    "port" => 5672,
    "login" => getenv("AMQP_USERNAME") ?: "guest",
    "password" => getenv("AMQP_PASSWORD") ?: "guest"
]);
$connection->connect();
$channel = new AMQPChannel($connection);
$exchange = new AMQPExchange($channel);
$exchange->setName("jobs.exchange");
$exchange->setType(AMQP_EX_TYPE_DIRECT);
$exchange->declareExchange();
$queue = new AMQPQueue($channel);
$queue->setName("jobs.queue");
$queue->declareQueue();
$removedCount = $queue->purge();
echo $removedCount;
$connection->disconnect();

The code is shown for learning. Adjust the class names, inputs and error handling to suit your application.

Important Behavior and Edge Cases

• This discards queued messages and should be reserved for intentional maintenance.
• Removes queued messages without deleting the queue itself.
• Observe differences in empty inputs, invalid states and optional extension availability where relevant.

Comparison With Related Approaches

Common Beginner Mistakes

Key Takeaways

• Removes queued messages without deleting the queue itself.
• This discards queued messages and should be reserved for intentional maintenance.
• Use the example that matches the values, runtime version and dependencies in your application.

AMQPQueue::purge is useful when its behavior matches the data structure and lifecycle of your PHP application. Choose it with a clear understanding of its preconditions and returned values.