Description: Load data from the server using a HTTP GET request.
url
A string containing the URL to which the request is sent.
data
A plain object or string that is sent to the server with the request.
success
A callback function that is executed if the request succeeds. Required if
dataType
is provided, but you can use
null
or
jQuery.noop
as a placeholder.
dataType
The type of data expected from the server. Default: Intelligent Guess (xml, json, script, text, html).
settings
A set of key/value pairs that configure the Ajax request. All properties except for
url
are optional. A default can be set for any option with
$.ajaxSetup(). See
jQuery.ajax( settings )for a complete list of all settings. The type option will automatically be set to
GET
.
This is a shorthand Ajax function, which is equivalent to:
The success
callback function is passed the returned data, which will be an XML root element, text string, JavaScript file, or JSON object, depending on the MIME type of the response. It is also passed the text status of the response.
As of jQuery 1.5, the success
callback function is also passed a "jqXHR" object (in jQuery 1.4, it was passed the XMLHttpRequest
object). However, since JSONP and cross-domain GET requests do not use XHR, in those cases the jqXHR
and textStatus
parameters passed to the success callback are undefined.
Most implementations will specify a success handler:
1
2
3
4
$.get( "ajax/test.html", function( data ) {
$( ".result" ).html( data );
alert( "Load was performed." );
This example fetches the requested HTML snippet and inserts it on the page.
The jqXHR ObjectAs of jQuery 1.5, all of jQuery's Ajax methods return a superset of the XMLHTTPRequest
object. This jQuery XHR object, or "jqXHR," returned by $.get()
implements the Promise interface, giving it all the properties, methods, and behavior of a Promise (see Deferred object for more information). The jqXHR.done()
(for success), jqXHR.fail()
(for error), and jqXHR.always()
(for completion, whether success or error; added in jQuery 1.6) methods take a function argument that is called when the request terminates. For information about the arguments this function receives, see the jqXHR Object section of the $.ajax()
documentation.
The Promise interface also allows jQuery's Ajax methods, including $.get()
, to chain multiple .done()
, .fail()
, and .always()
callbacks on a single request, and even to assign these callbacks after the request may have completed. If the request is already complete, the callback is fired immediately.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Deprecation Notice
var jqxhr = $.get( "example.php", function() {
alert( "second success" );
jqxhr.always(function() {
alert( "second finished" );
The jqXHR.success()
, jqXHR.error()
, and jqXHR.complete()
callback methods are removed as of jQuery 3.0. You can use jqXHR.done()
, jqXHR.fail()
, and jqXHR.always()
instead.
ajaxError
event. Alternatively, as of jQuery 1.5, the .error()
method of the jqXHR
object returned by jQuery.get() is also available for error handling.Request the test.php page, but ignore the return results.
Example 2Request the test.php page and send some additional data along (while still ignoring the return results).
1
Example 3
$.get( "test.php", { name: "John", time: "2pm" } );
Pass arrays of data to the server (while still ignoring the return results).
1
Example 4
$.get( "test.php", { "choices[]": ["Jon", "Susan"] } );
Alert the results from requesting test.php (HTML or XML, depending on what was returned).
1
2
3
Example 5
$.get( "test.php", function( data ) {
alert( "Data Loaded: " + data );
Alert the results from requesting test.cgi with an additional payload of data (HTML or XML, depending on what was returned).
1
2
3
4
Example 6
$.get( "test.cgi", { name: "John", time: "2pm" } )
alert( "Data Loaded: " + data );
Get the test.php page contents, which has been returned in json format (<?php echo json_encode( array( "name"=>"John","time"=>"2pm" ) ); ?>), and add it to the page.
1
2
3
4
5
Example 7
$.get( "test.php", function( data ) {
.append( "Name: " + data.name )
.append( "Time: " + data.time );
Get another page on the same domain. Outputs to console both the data returned and the type of data returned.
1
2
3
4
5
6
$.get( "/jQuery.ajax/", function( data ) {
console.log( typeof data );
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3