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

Daud khan · Accepted Answer · 2017-02-01 09:50:43Z

160

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

It will append all query string parameters into pagination link

answered Feb 1, 2017 at 9:50

Daud khan

2,5192 gold badges16 silver badges19 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Ehsan Over a year ago

Based on this, I used request helper in view: {{ $users->appends(request()->query())->links() }}

FosAvance Over a year ago

Or even better {{ $posts->appends(request()->except('page'))->links() }}

saber tabatabaee yazdi Over a year ago

@FosAvance thanks. this hadn't any value added. worked like Ehsan code for me. what is the difference??

Steen Schütt · Accepted Answer · 2020-09-02 12:23:52Z

71

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 2, 2020 at 12:23

Steen Schütt

1,5041 gold badge19 silver badges32 bronze badges

3 Comments

thursday_dan Over a year ago

You can also apply this directly to your model query. User::paginate()->withQueryString() which lets you do this inside your view: {{ $users->links() }}

Chris-MindflowAU Over a year ago

Laravel 10 docs no longer show this method of doing it, however it does work with the current version 10.

V. Bozz Dec 31, 2024 at 14:30

Laravel 11 has the withQueryString() documentation @Chris-MindflowAU laravel.com/docs/11.x/…

Jarek Tkaczyk · Accepted Answer · 2015-08-20 09:57:04Z

30

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, 2015 at 9:57

answered Jul 22, 2014 at 17:13

Jarek Tkaczyk

81.4k27 gold badges167 silver badges162 bronze badges

Comments

georaldc · Accepted Answer · 2016-07-15 18:26:08Z

19

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);

answered Jul 15, 2016 at 18:26

georaldc

1,94016 silver badges26 bronze badges

Comments

Sliq · Accepted Answer · 2021-07-09 09:36:07Z

19

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 9, 2021 at 9:36

Sliq

16.6k28 gold badges118 silver badges146 bronze badges

answered Dec 28, 2017 at 10:59

Luca C.

12.7k2 gold badges89 silver badges83 bronze badges

Comments

Arda · Accepted Answer · 2014-10-01 07:27:42Z

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 1, 2014 at 7:27

Arda

6,9633 gold badges53 silver badges70 bronze badges

6 Comments

Mr. Tomar Over a year ago

FatalErrorException in routes.php line 20: Class 'Paginator' not found

Arda Over a year ago

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.

Mr. Tomar Over a year ago

View::composer(\Paginator::getViewName(), function($view) { $queryString = array_except(Input::query(), \Paginator::getPageName()); $view->paginator->appends($queryString); }); not working

Arda Over a year ago

Which version of Laravel are you using ? @Tarzan

Mr. Tomar Over a year ago

Laravel 5, Can u suggest me how i get localhost/search/Filipino Filipino in my controller, want a filter according to filipino

|

Rasmus Christoffer Nielsen · Accepted Answer · 2018-10-05 11:14:21Z

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 5, 2018 at 11:14

Rasmus Christoffer Nielsen

1911 silver badge4 bronze badges

2 Comments

ctf0 Over a year ago

worth notting, that you better bind both paginator types, lenghaware and normal

TimmyG Over a year ago

this helped me solve my problem. I added a new answer for Laravel 8

xpredo · Accepted Answer · 2019-07-16 03:08:59Z

13

you can used request helper in view as same

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

answered Jul 16, 2019 at 3:08

xpredo

1,55021 silver badges29 bronze badges

Comments

Mayank Pandeyz · Accepted Answer · 2019-04-01 03:10:23Z

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 1, 2019 at 3:10

Mayank Pandeyz

26.3k4 gold badges43 silver badges61 bronze badges

answered Feb 14, 2019 at 7:10

sampath pallekumbura

1552 silver badges6 bronze badges

Comments

Chris-MindflowAU · Accepted Answer · 2023-08-20 17:09:33Z

6

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()

answered Aug 20, 2023 at 17:09

Chris-MindflowAU

4419 silver badges13 bronze badges

Comments

TimmyG · Accepted Answer · 2022-07-28 13:45:58Z

4

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;

answered Jul 28, 2022 at 13:45

TimmyG

7517 silver badges5 bronze badges

1 Comment

AwesomeUserName Over a year ago

2022 This should be the accepted answer!

Hassan Elshazly Eida · Accepted Answer · 2021-04-07 19:26:44Z

3

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

answered Apr 7, 2021 at 19:26

Hassan Elshazly Eida

88912 silver badges24 bronze badges

Comments

Adam Pery · Accepted Answer · 2023-03-10 12:28:21Z

3

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

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

Documentation here

answered Mar 10, 2023 at 12:28

Adam Pery

2,10223 silver badges21 bronze badges

Comments

csandreas1 · Accepted Answer · 2024-11-09 13:35:50Z

3

Simply use ->paginate(5)->withQueryString()

answered Nov 9, 2024 at 13:35

csandreas1

2,4202 gold badges37 silver badges58 bronze badges

Comments

Mohammad Taimoor Hussain · Accepted Answer · 2024-01-30 08:32:03Z

0

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

Add the following line to the AppServiceProvider.php file to include the query string in all paginations across the application. Make sure to import classes.

edited Jan 30, 2024 at 8:32

answered Jan 30, 2024 at 8:28

Mohammad Taimoor Hussain

12 bronze badges

1 Comment

Good Muyis Over a year ago

You don't need to copy and paste already given answers as yours.

Collectives™ on Stack Overflow

How to automatically append query string to laravel pagination links?

15 Answers 15

3 Comments

3 Comments

Comments

Comments

Comments

6 Comments

2 Comments

Comments

Comments

Comments

Updating @rasmus answer for Laravel 8.

1 Comment

Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

15 Answers 15

3 Comments

3 Comments

Comments

Comments

Comments

6 Comments

2 Comments

Comments

Comments

Comments

Updating @rasmus answer for Laravel 8.

1 Comment

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related