Laravel - check if Ajax request

Question

I have been trying to find a way to determine Ajax calls in Laravel but I have not found any documentation about it.

I have an index() controller function where I want to handle the response differently based on the nature of the request. Basically this is a resource controller method that is bound to GET request.

public function index()
{
    if(!$this->isLogin())
        return Redirect::to('login');
            
    if(isAjax()) // This is what I am needing.
    {
        return $JSON;
    }

    $data = array(
        'records' => $this->table->fetchAll()
    );

    $this->setLayout(compact('data'));
}

I know the other methods of determining the Ajax request in PHP but I want something specific to Laravel.

Thanks

Updated:

I tried using

if(Request::ajax())
{
    echo 'Ajax';
}

But I am receiving this error:

Non-static method Illuminate\Http\Request::ajax() should not be called statically, assuming $this from incompatible context

The class shows that this is not a static method.

score 243 · Accepted Answer · answered Mar 24 '15 at 11:53

243

Maybe this helps. You have to refer the @param

         /**       
         * Display a listing of the resource.
         *
         * @param  Illuminate\Http\Request $request
         * @return Response
         */
        public function index(Request $request)
        {
            if($request->ajax()){
                return "AJAX";
            }
            return "HTTP";
        }

answered Mar 24 '15 at 11:53

Crack_David

2,775
1
14
30

You are right. This will work in my case as i am using namespace of `Illuminate\Http\Request;` in my controllers. Thanks – Raheel Mar 24 '15 at 11:55
1

You can also use "request()->ajax()" if needed – badcom Nov 24 '17 at 13:26
I can confirm this works in 5.2. I used the helper `request()->ajax()` Thanks! – cbloss793 Apr 02 '19 at 16:25

score 31 · Answer 2 · answered Sep 17 '18 at 06:48

$request->wantsJson()

You can try $request->wantsJson() if $request->ajax() does not work

$request->ajax() works if your JavaScript library sets an X-Requested-With HTTP header.

By default Laravel set this header in js/bootstrap.js

window.axios = require('axios');

window.axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest';

In my case, I used a different frontend code and I had to put this header manually for $request->ajax() to work.

But $request->wantsJson() will check the axios query without the need for a header X-Requested-With:

// Determine if the current request is asking for JSON. This checks Content-Type equals application/json.
$request->wantsJson()
// or 
\Request::wantsJson() // not \Illuminate\Http\Request

Use `$request->wantsJson()` if your controller is deciding whether to respond with JSON or something else. This is a better approach than using `$request->isAjax()` because `wantsJson()` follows the HTTP spec for [Content Negotiation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation). — John Kary, Sep 08 '21 at 00:55

lukasgeiter · Answer 3 · 2015-03-24T11:57:47.043

24

You are using the wrong Request class. If you want to use the Facade like: Request::ajax() you have to import this class:

use Illuminate\Support\Facades\Request;

And not Illumiante\Http\Request

Another solution would be injecting an instance of the real request class:

public function index(Request $request){
    if($request->ajax()){
        return "AJAX";
    }

(Now here you have to import Illuminate\Http\Request)

edited Mar 24 '15 at 11:57

answered Mar 24 '15 at 11:56

lukasgeiter

147,337
26
332
270

you are right. I fixed that. Some other guy put a use statement above and i didn't look at that. Thanks :) – Raheel Mar 24 '15 at 11:57

Jnanaranjan · Answer 4 · 2015-08-04T07:58:39.093

23

To check an ajax request you can use if (Request::ajax())

Note: If you are using laravel 5, then in the controller replace

use Illuminate\Http\Request;

with

use Request;

I hope it'll work.

edited Aug 04 '15 at 07:58

answered Apr 29 '15 at 12:41

Jnanaranjan

1,304
15
31

score 11 · Answer 5 · answered Mar 24 '15 at 11:42

11

if(Request::ajax())

Looks to be the right answer. http://laravel.com/api/5.0/Illuminate/Http/Request.html#method_ajax

answered Mar 24 '15 at 11:42

Matthew Way

331
1
4

1

I am not sure if this is what you mean, but Laravel makes use of the Facade design pattern so that your calls can be made like static methods: http://laravel.com/docs/4.2/facades#facade-class-reference That link shows a list of Facades Laravel uses. Are you using it in a Controller? – Matthew Way Mar 24 '15 at 11:56
i was using wrong use statement. sorry But thanks for an overview of Facades :) This is informative. – Raheel Mar 24 '15 at 12:00

score 8 · Answer 6 · edited May 23 '17 at 12:02

8

For those working with AngularJS front-end, it does not use the Ajax header laravel is expecting. (Read more)

Use Request::wantsJson() for AngularJS:

if(Request::wantsJson()) { 
    // Client wants JSON returned 
}

edited May 23 '17 at 12:02

Community

1
1

answered Nov 07 '16 at 17:37

Justin

26,443
16
111
128

this should be the answer now – Salal Aslam Jun 21 '18 at 12:55

score 7 · Answer 7 · answered Dec 14 '17 at 20:56

7

Those who prefer to use laravel helpers they can check if a request is ajax using laravel request() helper.

if(request()->ajax())
   // code

answered Dec 14 '17 at 20:56

lee shin

894
11
6

score 4 · Answer 8 · answered Mar 24 '15 at 11:47

public function index()
{
    if(!$this->isLogin())
        return Redirect::to('login');

    if(Request::ajax()) // This is check ajax request
    {
      return $JSON;
    }

    $data = array();
    $data['records'] = $this->table->fetchAll();

    $this->setLayout(compact('data'));
}

score 3 · Answer 9 · answered Jul 08 '17 at 04:14

3

Sometimes Request::ajax() doesn't work, then use \Request::ajax()

answered Jul 08 '17 at 04:14

Nagibaba

4,218
1
35
43

It will not work if the namespace is not used. Anyways thanks – Raheel Dec 15 '17 at 00:55

score 1 · Answer 10 · answered Mar 11 '21 at 10:47

Do something like this
public function functionName(User $user): string
{
    (string) $message = "";
    // check if request is ajax
    if(request()->ajax())
    {
        if($this->isOwner($user->id)){
            $message = 'success';
        }else{
            $message = "You are unauthorized to perform this action.";
        }
    }else{
        $message = 'Wrong server request';
    }
    return $message;        
}

score 0 · Answer 11 · edited Jul 24 '16 at 09:56

0

after writing the jquery code perform this validation in your route or in controller.

$.ajax({
url: "/id/edit",
data:
name:name,
method:'get',
success:function(data){
  console.log(data);}
});

Route::get('/', function(){
if(Request::ajax()){
  return 'it's ajax request';}
});

edited Jul 24 '16 at 09:56

Gatogordo

2,629
2
22
32

answered Jul 24 '16 at 08:39

Muhammad Awais

1
2

score -1 · Answer 12 · answered Nov 26 '20 at 06:50

-1

Most of the answers are working fine. We can also check the request header

request()->header('Accept')=='application/json'

to check the request type

answered Nov 26 '20 at 06:50

Rahul Reghunath

1,210
13
23

Laravel - check if Ajax request

12 Answers12

$request->wantsJson()

Linked