.ajaxSend()


.ajaxSend( handler(event, jqXHR, ajaxOptions) )Returns: jQuery

Description: Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.

Whenever an Ajax request is about to be sent, jQuery triggers the ajaxSend event. Any and all handlers that have been registered with the .ajaxSend() method are executed at this time.

To observe this method in action, set up a basic Ajax load request:

1
2
3
<div class="trigger">Trigger</div>
<div class="result"></div>
<div class="log"></div>

Attach the event handler to the document:

1
2
3
$( document ).ajaxSend(function() {
$( ".log" ).text( "Triggered ajaxSend handler." );
});

Now, make an Ajax request using any jQuery method:

1
2
3
$( ".trigger" ).click(function() {
$( ".result" ).load( "ajax/test.html" );
});

When the user clicks the element with class trigger and the Ajax request is about to begin, the log message is displayed.

As of jQuery 1.8, the .ajaxSend() method should only be attached to document.

All ajaxSend handlers are invoked, regardless of what Ajax request is to be sent. If you must differentiate between the requests, use the parameters passed to the handler. Each time an ajaxSend handler is executed, it is passed the event object, the jqXHR object (in version 1.4, XMLHttpRequestobject), and the settings object that was used in the creation of the Ajax request. For example, you can restrict the callback to only handling events dealing with a particular URL:

1
2
3
4
5
$( document ).ajaxSend(function( event, jqxhr, settings ) {
if ( settings.url == "ajax/test.html" ) {
$( ".log" ).text( "Triggered ajaxSend handler." );
}
});

Additional Notes:

  • If $.ajax() or $.ajaxSetup() is called with the global option set to false, the .ajaxSend() method will not fire.

Example:

Show a message before an Ajax request is sent.

1
2
3
$( document ).ajaxSend(function( event, request, settings ) {
$( "#msg" ).append( "<li>Starting request at " + settings.url + "</li>" );
});