How to automatically append query string to laravel pagination links?

Question

I am working on search filter on checkbox click, with Laravel and Ajax call. So I get results when I click on a checkbox. my query is as follows:

$editors = User::with(['editor.credentials','editor.specialties','editor.ratings']);
$temp=$editors->whereHas('editor', function($q) use ($a_data){
    $q->whereHas('specialties',function($sq) use($a_data){
        $sq->whereIn('specialty',$a_data);
    });
})->paginate(2);

This gives me all the data I need. however how should I get the links for pagination?

$temp->setBaseUrl('editors');
$links = $temp->links()->render();

I am currently doing this and with $links which I am sending over as response to ajax call, I set the pagination with $links data. Now, I need to append the query to next page like page=2?query="something". I don't know how should I go about appending the remaining query result links to next page links. i.e. I don;t know what should come in the query="something" part. Can someone guide me. thanks

score 156 · Answer 1 · answered Feb 01 '17 at 09:50

156

{{ $users->appends($_GET)->links() }}

It will append all query string parameters into pagination link

answered Feb 01 '17 at 09:50

Daud khan

2,413
2
14
18

27

Based on this, I used request helper in view: `{{ $users->appends(request()->query())->links() }}` – Ehsan Sep 26 '17 at 21:52
7

Or even better `{{ $posts->appends(request()->except('page'))->links() }}` – FosAvance Mar 11 '19 at 19:51
1

@FosAvance thanks. this hadn't any value added. worked like Ehsan code for me. what is the difference?? – saber tabatabaee yazdi Oct 05 '20 at 05:10

score 58 · Answer 2 · answered Sep 02 '20 at 12:23

58

As of Laravel 7, you can call the withQueryString() method on your Paginator instance.

Quote from the documentation:

If you wish to append all current query string values to the pagination links you may use the withQueryString method:
{{ $users->withQueryString()->links() }}

See "Appending To Pagination Links": https://laravel.com/docs/7.x/pagination#displaying-pagination-results

answered Sep 02 '20 at 12:23

Steen Schütt

1,355
1
17
31

4

You can also apply this directly to your model query. `User::paginate()->withQueryString()` which lets you do this inside your view: `{{ $users->links() }}` – thursday_dan Jun 02 '21 at 09:33
Thanks bro this is the best solution. – Freddy Daniel Jun 22 '21 at 17:23
1

Laravel 10 docs no longer show this method of doing it, however it **does work** _with the current version 10_. – ChrisDeDavidMindflowAU Aug 20 '23 at 17:05

Jarek Tkaczyk · Accepted Answer · 2015-08-20T09:57:04.137

28

Check the answer from @Arda, as it's global solution. Below you can find how to do it manually.

Use appends on Paginator:

$querystringArray = Input::only(['search','filter','order']); // sensible examples

// or:
$querystringArray = ['queryVar' => 'something', 'anotherVar' => 'something_else'];

$temp->appends($querystringArray);

edited Aug 20 '15 at 09:57

answered Jul 22 '14 at 17:13

Jarek Tkaczyk

78,987
25
159
157

score 18 · Answer 4 · edited Jul 09 '21 at 09:36

18

Append all input except the actual page, form token and what you don't want to pass:

$paginatedCollection->appends($request->except(['page','_token']));

edited Jul 09 '21 at 09:36

Sliq

15,937
27
110
143

answered Dec 28 '17 at 10:59

Luca C.

11,714
1
86
77

score 17 · Answer 5 · answered Jul 15 '16 at 18:26

For the latest version of Laravel at the moment (5.2), you can just use the Request facade to retrieve the query string and pass that to your paginator's appends() method

$input = Request::input();
$myModelsPaginator = App\Models\MyModel::paginate();
$myModelsPaginator->appends($input);

score 16 · Answer 6 · answered Oct 01 '14 at 07:27

16

Add this anywhere in your app (e.g routes.php, filters.php or anything that's autoloaded), no need to edit any pagination codes that is written already. This works flawlessly using view composers, and you don't need to know any query string parameters:

////////PAGINATION QUERY STRING APPEND
View::composer(Paginator::getViewName(), function($view) {
    $queryString = array_except(Input::query(), Paginator::getPageName());
    $view->paginator->appends($queryString);
});
//////////////////

answered Oct 01 '14 at 07:27

Arda

6,756
3
47
67

FatalErrorException in routes.php line 20: Class 'Paginator' not found – Mr. Tomar Nov 26 '15 at 07:49
1

This Answer is for Laravel 4 @Tarzan, In Laravel 5, classes are PSR-4 standards, so you need to add \ character before. But I've not tried this in LAravel 5. – Arda Nov 26 '15 at 10:09
View::composer(\Paginator::getViewName(), function($view) { $queryString = array_except(Input::query(), \Paginator::getPageName()); $view->paginator->appends($queryString); }); not working – Mr. Tomar Nov 26 '15 at 11:07
Which version of Laravel are you using ? @Tarzan – Arda Nov 26 '15 at 11:23
Laravel 5, Can u suggest me how i get http://localhost/search/Filipino Filipino in my controller, want a filter according to filipino – Mr. Tomar Nov 26 '15 at 12:17
In Laravel 5 class `Paginator` don't have `getViewName()` method. This solution is only for Laravel 4. – Marek Skiba Dec 05 '16 at 10:21

score 15 · Answer 7 · answered Oct 05 '18 at 11:14

15

Inspired from previous answers I ended up using the service container for both frontend + api support.

In your AppServiceProvider@boot() method:

$this->app->resolving(LengthAwarePaginator::class, function ($paginator) {
    return $paginator->appends(array_except(Input::query(), $paginator->getPageName()));
});

answered Oct 05 '18 at 11:14

Rasmus Christoffer Nielsen

191
1
4

2

worth notting, that you better bind both paginator types, lenghaware and normal – ctf0 Feb 17 '20 at 21:10
this helped me solve my problem. I added a new answer for Laravel 8 – TimmyG Jul 28 '22 at 13:41

score 13 · Answer 8 · answered Jul 16 '19 at 03:08

13

you can used request helper in view as same

{{ $users->appends(request()->query())->links() }}

answered Jul 16 '19 at 03:08

xpredo

1,282
17
27

3

Perfect Answer. Thanks – Hasnat Babur Jan 10 '20 at 06:32

score 10 · Answer 9 · edited Apr 01 '19 at 03:10

10

in your view where you display pagination...

{{ $results->appends(Request::except('page'))->links() }}

appends keeps the query string value except "page". not sure if it will work with POST request

edited Apr 01 '19 at 03:10

Mayank Pandeyz

25,704
4
40
59

answered Feb 14 '19 at 07:10

sampath pallekumbura

155
2
6

score 3 · Answer 10 · answered Apr 07 '21 at 19:26

3

  {{ $users->appends(Request::only(['filter','search']))->links()}}

answered Apr 07 '21 at 19:26

Hassan Elshazly Eida

605
5
20

score 2 · Answer 11 · answered Jul 28 '22 at 13:45

Updating @rasmus answer for Laravel 8.

In your AppServiceProvider boot method, add the following lines and your existing query string will be be used for all pagination links

$this->app->resolving(Paginator::class, function ($paginator) {
    return $paginator->appends(Arr::except(Request::query(), $paginator->getPageName()));
});
$this->app->resolving(LengthAwarePaginator::class, function ($paginator) {
    return $paginator->appends(Arr::except(Request::query(), $paginator->getPageName()));
});

And for completeness, use these classes:

use Illuminate\Pagination\LengthAwarePaginator;
use Illuminate\Pagination\Paginator;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Request;

2022 This should be the accepted answer! – AwesomeUserName Nov 10 '22 at 16:09 — AwesomeUserName, Nov 10 '22 at 16:09

score 1 · Answer 12 · answered Mar 10 '23 at 12:28

1

From Laravel 8 use add 'withQueryString()' to paginate:

$users = User::paginate(15)->withQueryString();

Documentation here

answered Mar 10 '23 at 12:28

Adam Pery

1,924
22
21

score 1 · Answer 13 · answered Aug 20 '23 at 17:09

Laravel 10 can use withQueryString

Example: $users = User::paginate(15)->withQueryString();

https://laravel.com/docs/10.x/pagination#appending-query-string-values

Or, when displaying the links using the helper method, however it appears that method is not documented any more (not that I could find using the search bar in their docs).

$users->withQueryString()->links()

How to automatically append query string to laravel pagination links?

13 Answers13

Updating @rasmus answer for Laravel 8.

Linked

Related