* @output wp-includes/js/wp-util.js
/* global _wpUtilSettings */
window.wp = window.wp || {};
// Check for the utility settings.
var settings = typeof _wpUtilSettings === 'undefined' ? {} : _wpUtilSettings;
* 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".
* @return {function} A function that lazily-compiles the template requested.
wp.template = _.memoize(function ( id ) {
* 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.
evaluate: /<#([\s\S]+?)#>/g,
interpolate: /\{\{\{([\s\S]+?)\}\}\}/g,
escape: /\{\{([^\}]+?)\}\}(?!\})/g,
return function ( data ) {
compiled = compiled || _.template( $( '#tmpl-' + id ).html(), options );
* Tools for sending ajax requests with JSON responses and built in error handling.
* Mirrors and wraps jQuery's ajax APIs.
settings: settings.ajax || {},
* wp.ajax.post( [action], [data] )
* Sends a POST request to WordPress.
* @param {(string|Object)} action The slug of the action to fire in WordPress or options passed
* @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 ) {
data: _.isObject( action ) ? action : _.extend( data || {}, { action: action })
* wp.ajax.send( [action], [options] )
* Sends a POST request to WordPress.
* @param {(string|Object)} action The slug of the action to fire in WordPress or options passed
* @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 ) {
if ( _.isObject( action ) ) {
options.data = _.extend( options.data || {}, { action: action });
options = _.defaults( options || {}, {
url: wp.ajax.settings.url,
deferred = $.Deferred( function( deferred ) {
// Transfer success/error callbacks.
deferred.done( options.success );
deferred.fail( options.error );
// Use with PHP's wp_send_json_success() and wp_send_json_error().
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 };
if ( _.isObject( response ) && ! _.isUndefined( response.success ) ) {
deferred[ response.success ? 'resolveWith' : 'rejectWith' ]( this, [response.data] );
deferred.rejectWith( this, [response] );
deferred.rejectWith( this, arguments );
promise = deferred.promise();
promise.abort = function() {