jQuery.ajaxSetup()

Categories: Ajax > Low-Level Interface

jQuery.ajaxSetup( options )Returns: PlainObject

Description: Set default values for future Ajax requests. Its use is not recommended.

For details on the settings available for $.ajaxSetup(), see $.ajax().

All subsequent Ajax calls using any function will use the new settings, unless overridden by the individual calls, until the next invocation of $.ajaxSetup().

Note: The settings specified here will affect all calls to $.ajax or Ajax-based derivatives such as $.get(). This can cause undesirable behavior since other callers (for example, plugins) may be expecting the normal default settings. For that reason we strongly recommend against using this API. Instead, set the options explicitly in the call or define a simple plugin to do so.

For example, the following sets a default for the url parameter before pinging the server repeatedly:

1
2
3
 
$.ajaxSetup({
  url: "ping.php"
});

Now each time an Ajax request is made, the "ping.php" URL will be used automatically:

1
2
3
4
 
$.ajax({
  // url not set here; uses ping.php
  data: { "name": "Dan" }
});

Note: Global callback functions should be set via .on() with their respective global Ajax events—ajaxStart, ajaxStop, ajaxComplete, ajaxError, ajaxSuccess, ajaxSend—rather than within the options object for $.ajaxSetup().

Example:

Sets the defaults for Ajax requests to the url "/xmlhttp/", disables global handlers and uses POST instead of GET. The following Ajax requests then sends some data without having to set anything else.

1
2
3
4
5
6
 
$.ajaxSetup({
  url: "/xmlhttp/",
  global: false,
  type: "POST"
});
$.ajax({ data: myData });