Laravel Request: wantsJson()

Defination

This function finds if the request is asking for JSON in return.

Syntax

public function wantsJson():bool

Usecases

If you want to check if response needs to be JSON
If you want to check if request is of JSON type

Example-1: Use of wantsJson function in Laravel Controller

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserController extends Controller
{
    public function index(Request $request)
    {
        dd($request->wantsJson()); // output:- false
    }
}

Example-2: Use of wantsJson function using request()

Following example can be used anywhere in Laravel app:

namespace App\Helpers;

use Illuminate\Http\Request;

class Test 
{
    public function __construct() 
    {
        dd(request()->wantsJson()); // output:- false
    }
}