jQuery.ajaxSetup()
jQuery.ajaxSetup( options )
Description: Set default values for future Ajax requests.
-
version added: 1.1jQuery.ajaxSetup( options )
optionsA set of key/value pairs that configure the default Ajax request. All options are optional.
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()
.
For example, the following sets a default for the url
parameter before pinging the server repeatedly:
$.ajaxSetup({ url: 'ping.php' });
Now each time an Ajax request is made, the "ping.php" URL will be used automatically:
$.ajax({ // url not set here; uses ping.php data: {'name': 'Dan'} });
Note: Global callback functions should be set with their respective global Ajax event handler methods—
.ajaxStart()
,.ajaxStop()
,.ajaxComplete()
,.ajaxError()
,.ajaxSuccess()
,.ajaxSend()
—rather than within theoptions
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.
$.ajaxSetup({
url: "/xmlhttp/",
global: false,
type: "POST"
});
$.ajax({ data: myData });