/**
* wp.template( id )
*
- * Fetches a template by id.
+ * Fetch a JavaScript template for an id, and return a templating function for it.
*
* @param {string} id A string that corresponds to a DOM element with an id prefixed with "tmpl-".
* For example, "attachment" maps to "tmpl-attachment".
*/
wp.template = _.memoize(function ( id ) {
var compiled,
+ /*
+ * Underscore's default ERB-style templates are incompatible with PHP
+ * when asp_tags is enabled, so WordPress uses Mustache-inspired templating syntax.
+ *
+ * @see trac ticket #22344.
+ */
options = {
evaluate: /<#([\s\S]+?)#>/g,
interpolate: /\{\{\{([\s\S]+?)\}\}\}/g,
};
return function ( data ) {
- compiled = compiled || _.template( $( '#tmpl-' + id ).html(), null, options );
+ compiled = compiled || _.template( $( '#tmpl-' + id ).html(), options );
return compiled( data );
};
});
*
* Sends a POST request to WordPress.
*
- * @param {string} action The slug of the action to fire in WordPress.
- * @param {object} data The data to populate $_POST with.
- * @return {$.promise} A jQuery promise that represents the request.
+ * @param {(string|object)} action The slug of the action to fire in WordPress or options passed
+ * to jQuery.ajax.
+ * @param {object=} data Optional. The data to populate $_POST with.
+ * @return {$.promise} A jQuery promise that represents the request,
+ * decorated with an abort() method.
*/
post: function( action, data ) {
return wp.ajax.send({
*
* Sends a POST request to WordPress.
*
- * @param {string} action The slug of the action to fire in WordPress.
- * @param {object} options The options passed to jQuery.ajax.
- * @return {$.promise} A jQuery promise that represents the request.
+ * @param {(string|object)} action The slug of the action to fire in WordPress or options passed
+ * to jQuery.ajax.
+ * @param {object=} options Optional. The options passed to jQuery.ajax.
+ * @return {$.promise} A jQuery promise that represents the request,
+ * decorated with an abort() method.
*/
send: function( action, options ) {
+ var promise, deferred;
if ( _.isObject( action ) ) {
options = action;
} else {
context: this
});
- return $.Deferred( function( deferred ) {
+ deferred = $.Deferred( function( deferred ) {
// Transfer success/error callbacks.
if ( options.success )
deferred.done( options.success );
delete options.error;
// Use with PHP's wp_send_json_success() and wp_send_json_error()
- $.ajax( options ).done( function( response ) {
- // Treat a response of `1` as successful for backwards
- // compatibility with existing handlers.
+ deferred.jqXHR = $.ajax( options ).done( function( response ) {
+ // Treat a response of 1 as successful for backward compatibility with existing handlers.
if ( response === '1' || response === 1 )
response = { success: true };
}).fail( function() {
deferred.rejectWith( this, arguments );
});
- }).promise();
+ });
+
+ promise = deferred.promise();
+ promise.abort = function() {
+ deferred.jqXHR.abort();
+ return this;
+ };
+
+ return promise;
}
};