Building a Pagination Endpoint in PHP

A pagination endpoint returns a bounded and consistently ordered subset of results.

What It Does

A pagination endpoint returns a bounded and consistently ordered subset of results. The following examples distinguish a normal use case, a boundary case and a practical application.

Requirements and Compatibility

PHP 8.x and a local test environment. Apply input validation, correct error handling and the requirements of any optional libraries.

The code focuses on the core concept. Production implementation may also need routes, validation, persistence, authorization or deployment tooling.

Example 1: Basic Behavior

Understand the primary operation and its inputs.

<?php
$page = 3; $size = 20;
$page = max(1, $page); $size = min(max($size, 1), 100);
echo ($page - 1) * $size;

Example 2: Another Case

Check failure behavior or a different execution path.

<?php
$rows = [['id' => 11], ['id' => 13], ['id' => 18]];
$after = 11;
print_r(array_values(array_filter($rows, fn ($row) => $row['id'] > $after)));

Practical Example: Putting It to Use

Apply the behavior in a small, controlled scenario.

<?php
$cursor = base64_encode(json_encode(['last_id' => 18], JSON_THROW_ON_ERROR));
$decoded = json_decode(base64_decode($cursor, true), true, 512, JSON_THROW_ON_ERROR);
echo $decoded['last_id']; // Authenticate cursors if they carry trusted state

Important Behavior and Edge Cases

Always cap page size and choose a stable sort with a unique tiebreaker.

Comparison with Related Functions or Approaches

Common Beginner Mistakes

Key Takeaways

• A pagination endpoint returns a bounded and consistently ordered subset of results.
• Always cap page size and choose a stable sort with a unique tiebreaker.
• Cursor pagination reduces deep OFFSET scans and concurrent page drift.

Before adapting these examples, verify the return values, test the failure paths and confirm that your application meets its security and environment requirements.