\n

Paginate<\/h1>\n\n

\n @foreach ($users as $user)\n
• {{ $user->name }}<\/li>\n @endforeach\n <\/ul>\n\n {{ $users->links() }}\n <\/div>\n<\/body>\n<\/html>\n<\/pre>\n

  The resulting page would look something like this:<\/p>\n

  <\/p>\n

  Let's break down what's happening in the Blade view:<\/p>\n

  \n
  • We're looping through each user that is present in the $users<\/code> field (the IlluminatePaginationLengthAwarePaginator<\/code> object) and outputting their name.<\/li>\n
  • We're calling the links<\/code> method on the $users<\/code> object. This is a really handy method which returns some HTML that displays the pagination links (e.g., \"Previous\", \"Next\", and the page numbers). This means you don't have to worry about creating the pagination links yourself, and Laravel will handle all of that for you.<\/li>\n<\/ul>\n

    We can also see that the paginate<\/code> method is giving us an overview of the pagination data. We can see that we're viewing the 16th to 30th records, out of a total of 50 records. We can also see that we're on the second page and that there are a total of 4 pages.<\/p>\n

    It's important to note that the links<\/code> method will return the HTML styled using Tailwind CSS. If you wish to use something other than Tailwind or you want to style the pagination links yourself, you can check out the documentation on customizing pagination views.<\/p>\n

    #Using paginate<\/code> in API Endpoints<\/h3>\n

    As well as using the paginate<\/code> method in Blade views, you can also use it in API endpoints. Laravel makes this process easy by automatically converting the paginated data into JSON.<\/p>\n

    For instance, we could build an \/api\/users<\/code> endpoint (by adding the following route to our routes\/api.php<\/code> file) which returns the paginated users in JSON format:<\/p>\n

    use App\\Models\\User;\n\n$users = User::query()->paginate();\n<\/pre>\n
    Accessing the \/api\/users<\/code> endpoint would return a JSON response similar to the following (please note I've limited the data<\/code> field to just 3 records for the sake of brevity):<\/p>\n
    use App\\Models\\User;\nuse Illuminate\\Support\\Facades\\Route;\n\nRoute::get('users', function () {\n    $users = User::query()->paginate();\n\n    return view('users.index', [\n        'users' => $users,\n    ]);\n});\n<\/pre>\n
    Let's break down the JSON response:<\/p>\n
    \n
    \ncurrent_page<\/code> - The current page we're on. In this case, we're on the first page.<\/li>\n
    \ndata<\/code> - The actual data itself that's being returned. In this case, it contains the first 15 users (shortened to 3 for brevity).<\/li>\n
    \nfirst_page_url<\/code> - The URL to the first page of data.<\/li>\n
    \nfrom<\/code> - The starting record number of the data being returned. In this case, it's the first record. If we were on the second page, this would be 16.<\/li>\n
    \nlast_page<\/code> - The total number of pages of data. In this case, there are 4 pages.<\/li>\n
    \nlast_page_url<\/code> - The URL to the last page of data.<\/li>\n
    \nlinks<\/code> - An array of links to the different pages of data. This includes the \"Previous\" and \"Next\" links, as well as the page numbers.<\/li>\n
    \nnext_page_url<\/code> - The URL to the next page of data.<\/li>\n
    \npath<\/code> - The base URL of the endpoint.<\/li>\n
    \nper_page<\/code> - The number of records being returned per page. In this case, it's 15.<\/li>\n
    \nprev_page_url<\/code> - The URL to the previous page of data. In this case, it's null<\/code> because we're on the first page. If we were on the second page, this would be the URL to the first page.<\/li>\n
    \nto<\/code> - The ending record number of the data being returned. In this case, it's the 15th record. If we were on the second page, this would be 30.<\/li>\n
    \ntotal<\/code> - The total number of records in the dataset. In this case, there are 50 records.<\/li>\n<\/ul>\n
    #The Underlying SQL Queries<\/h3>\n
    Using the paginate<\/code> method in Laravel results in two SQL queries being run:<\/p>\n
    \n
    The first query fetches the total number of records in the dataset. This is used to determine information such as the total number of pages and the total number of records.<\/li>\n
    The second query fetches the subset of data based on the offset and limit values. For example, it might be fetching the users for us to process and return.<\/li>\n<\/ul>\n
    So if we wanted to fetch the first page of users (with 15 users per page), the following SQL queries would be run:<\/p>\n
    use App\\Models\\User;\n\n$users = User::query()->paginate();\n<\/pre>\n
    and<\/p>\n
    use App\\Models\\User;\nuse Illuminate\\Support\\Facades\\Route;\n\nRoute::get('users', function () {\n    $users = User::query()->paginate();\n\n    return view('users.index', [\n        'users' => $users,\n    ]);\n});\n<\/pre>\n
    In the second query, we can see that the limit<\/code> value is set to 15. This is the number of records that are returned per page.<\/p>\n
    The offset<\/code> value is calculated as follows:<\/p>\n
    \n\n