Ajax call with contentType: 'application/json' not working
I have an ajax call, that sends form data to a php function. Since I read a lot that using contentType: 'application/json'
is best practice I wanted to give it a try as well. But unfortunately my script doesn't return anything when I use it. If I remove it, the script does what it is supposed to do.
Do you have any idea what the reason might be and why? Thank you!
$('#Form').submit(function(e) {
e.preventDefault();
var content = $(this).serialize() + "&ajax=1";
$.ajax('app/class/controller/contactForm.php', {
type: "POST",
//contentType: 'application/json',
dataType: 'json',
data: content,
success: function(result) {
console.log(result);
}
});
})
and my PHP:
if(isset($_POST['ajax']) && $_POST['ajax'] === '1') {
echo json_encode(validateForm($_POST));
}
When using contentType: 'application/json'
you will not be able to rely on $_POST
being populated. $_POST
is only populated for form-encoded content types.
As such, you need to read your data from PHP raw input like this:
$input = file_get_contents('php://input');
$object = json_decode($input);
Of course if you want to send application/json
you should actually send JSON, which you are not doing. You either need to build the object serialization to JSON directly, or you need to do something like this - Convert form data to JavaScript object with jQuery - to serialize the object from the form.
Honestly in your case, since you are dealing with form data, I don't quite think the use case for using application/json
is there.
The best practice you refer to is about the server script setting the Content-Type
for JSON to "application/json":
Header('Content-Type: application/json; charset=UTF8');
This is because otherwise a default Content-Type
will be sent, often a catch-all text/html
, and this could lead to an incomprehension with the client.
If you do not specify yourself a Content-Type in the jQuery request, jQuery will determine the most appropriate one. The problem here is that you were sending a POST form, for which the default Content-Type
set by jQuery is application/x-www-form-urlencoded
, which tells PHP to decode the data as POST fields and populate $_POST
. Your script would have then recovered its parameters from $_POST
(or maybe $_REQUEST
).
By changing it to application/json
, $_POST
will no longer be populated, the receiving script operation won't receive the parameters where it was expecting to, and the operation breaks.
So you either need to:
- not specify the Content-Type yourself (better, IMHO)
- set a Content-Type of
application/x-www-form-urlencoded; charset=UTF-8
- set a Content-Type of
application/json; charset=UTF-8
and modify the script to parse the POST stream and decode the JSON data; see this answer.
The third option requires proper handling of php://input
.
The PHP script should be setting the Content-Type header.
if(isset($_POST['ajax']) && $_POST['ajax'] === '1') {
header('Content-Type: application/json');
echo json_encode(validateForm($_POST));
}