wp_send_json_success( mixed $data = null, int $status_code = null, int $options )

Sends a JSON response back to an Ajax request, indicating success.

Contents

Parameters

$data mixed Optional
Data to encode as JSON, then print and die.

Default: null

$status_code int Optional
The HTTP status code to output.

Default: null

$options int Optional
Options to be passed to json_encode(). Default 0.

Top ↑

More Information

The response object will always have a success key with the value true. If anything is passed to the function it will be encoded as the value for a data key.

Example arrays such as the following are converted to JSON:

$response = array( 'success' => true );                   //if $data is empty
$response = array( 'success' => true, 'data' => $data );  //if $data is set

Top ↑

Source

File: wp-includes/functions.php. View all references 

function wp_send_json_success( $data = null, $status_code = null, $options = 0 ) {
	$response = array( 'success' => true );

	if ( isset( $data ) ) {
		$response['data'] = $data;
	}

	wp_send_json( $response, $status_code, $options );
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
locate_block_template() wp-includes/block-template.php

Finds a block template with equal or higher specificity than a given PHP template file.
wp_ajax_send_password_reset() wp-admin/includes/ajax-actions.php

Ajax handler sends a password reset link.
wp_ajax_nopriv_generate_password() wp-admin/includes/ajax-actions.php

Ajax handler for generating a password in the no-privilege context.
wp_ajax_toggle_auto_updates() wp-admin/includes/ajax-actions.php

Ajax handler to enable or disable plugin and theme auto-updates.
wp_ajax_media_create_image_subsizes() wp-admin/includes/ajax-actions.php

Ajax handler for creating missing image sub-sizes for just uploaded images.
wp_ajax_health_check_get_sizes() wp-admin/includes/ajax-actions.php

Ajax handler for site health check to get directories and database sizes.
wp_ajax_health_check_dotorg_communication() wp-admin/includes/ajax-actions.php

Ajax handler for site health checks on server communication.
wp_ajax_health_check_background_updates() wp-admin/includes/ajax-actions.php

Ajax handler for site health checks on background updates.
wp_ajax_health_check_loopback_requests() wp-admin/includes/ajax-actions.php

Ajax handler for site health checks on loopback requests.
wp_ajax_health_check_site_status_result() wp-admin/includes/ajax-actions.php

Ajax handler for site health check to update the result status.
wp_ajax_wp_privacy_export_personal_data() wp-admin/includes/ajax-actions.php

Ajax handler for exporting a user’s personal data.
wp_ajax_wp_privacy_erase_personal_data() wp-admin/includes/ajax-actions.php

Ajax handler for erasing personal data.
WP_Customize_Manager::handle_load_themes_request() wp-includes/class-wp-customize-manager.php

Loads themes into the theme browsing/installation UI.
WP_Customize_Manager::handle_override_changeset_lock_request() wp-includes/class-wp-customize-manager.php

Removes changeset lock when take over request is sent via Ajax.
WP_Customize_Manager::handle_dismiss_autosave_or_lock_request() wp-includes/class-wp-customize-manager.php

Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
WP_Customize_Manager::handle_changeset_trash_request() wp-includes/class-wp-customize-manager.php

Handles request to trash a changeset.
wp_ajax_edit_theme_plugin_file() wp-admin/includes/ajax-actions.php

Ajax handler for editing a theme or plugin file.
wp_ajax_get_community_events() wp-admin/includes/ajax-actions.php

Handles Ajax requests for community events
WP_Customize_Nav_Menus::ajax_insert_auto_draft_post() wp-includes/class-wp-customize-nav-menus.php

Ajax handler for adding a new auto-draft post.
wp_ajax_search_install_plugins() wp-admin/includes/ajax-actions.php

Ajax handler for searching plugins to install.
wp_ajax_delete_plugin() wp-admin/includes/ajax-actions.php

Ajax handler for deleting a plugin.
wp_ajax_search_plugins() wp-admin/includes/ajax-actions.php

Ajax handler for searching plugins.
wp_ajax_install_theme() wp-admin/includes/ajax-actions.php

Ajax handler for installing a theme.
wp_ajax_update_theme() wp-admin/includes/ajax-actions.php

Ajax handler for updating a theme.
wp_ajax_delete_theme() wp-admin/includes/ajax-actions.php

Ajax handler for deleting a theme.
wp_ajax_install_plugin() wp-admin/includes/ajax-actions.php

Ajax handler for installing a plugin.
wp_ajax_get_post_thumbnail_html() wp-admin/includes/ajax-actions.php

Ajax handler for retrieving HTML for the featured image.
WP_Customize_Selective_Refresh::handle_render_partials_request() wp-includes/customize/class-wp-customize-selective-refresh.php

Handles the Ajax request to return the rendered partials for the requested placements.
wp_ajax_generate_password() wp-admin/includes/ajax-actions.php

Ajax handler for generating a password.
wp_ajax_save_wporg_username() wp-admin/includes/ajax-actions.php

Ajax handler for saving the user’s WordPress.org username.
WP_Customize_Nav_Menus::ajax_load_available_items() wp-includes/class-wp-customize-nav-menus.php

Ajax handler for loading available menu items.
WP_Customize_Nav_Menus::ajax_search_available_items() wp-includes/class-wp-customize-nav-menus.php

Ajax handler for searching available menu items.
wp_ajax_crop_image() wp-admin/includes/ajax-actions.php

Ajax handler for cropping an image.
WP_Customize_Manager::refresh_nonces() wp-includes/class-wp-customize-manager.php

Refreshes nonces for the current preview.
wp_ajax_update_plugin() wp-admin/includes/ajax-actions.php

Ajax handler for updating a plugin.
wp_ajax_destroy_sessions() wp-admin/includes/ajax-actions.php

Ajax handler for destroying multiple open sessions for a user.
Custom_Background::ajax_background_add() wp-admin/includes/class-custom-background.php

Handles Ajax request for adding custom background context to an attachment.
wp_ajax_parse_embed() wp-admin/includes/ajax-actions.php

Apply [embed] Ajax handlers to a string.
wp_ajax_parse_media_shortcode() wp-admin/includes/ajax-actions.php
wp_ajax_set_attachment_thumbnail() wp-admin/includes/ajax-actions.php

Ajax handler for setting the featured image for an attachment.
wp_ajax_save_attachment_order() wp-admin/includes/ajax-actions.php

Ajax handler for saving the attachment order.
wp_ajax_send_attachment_to_editor() wp-admin/includes/ajax-actions.php

Ajax handler for sending an attachment to the editor.
wp_ajax_send_link_to_editor() wp-admin/includes/ajax-actions.php

Ajax handler for sending a link to the editor.
wp_ajax_get_revision_diffs() wp-admin/includes/ajax-actions.php

Ajax handler for getting revision diffs.
wp_ajax_save_user_color_scheme() wp-admin/includes/ajax-actions.php

Ajax handler for auto-saving the selected color scheme for a user’s own profile.
wp_ajax_query_themes() wp-admin/includes/ajax-actions.php

Ajax handler for getting themes from themes_api() .
wp_ajax_image_editor() wp-admin/includes/ajax-actions.php

Ajax handler for image editing.
wp_ajax_set_post_thumbnail() wp-admin/includes/ajax-actions.php

Ajax handler for setting the featured image.
wp_ajax_wp_fullscreen_save_post() wp-admin/includes/ajax-actions.php

Ajax handler for saving posts from the fullscreen editor.
wp_ajax_get_attachment() wp-admin/includes/ajax-actions.php

Ajax handler for getting an attachment.
wp_ajax_query_attachments() wp-admin/includes/ajax-actions.php

Ajax handler for querying attachments.
wp_ajax_save_attachment() wp-admin/includes/ajax-actions.php

Ajax handler for updating attachment attributes.
wp_ajax_save_attachment_compat() wp-admin/includes/ajax-actions.php

Ajax handler for saving backward compatible attachment attributes.
wp_ajax_meta_box_order() wp-admin/includes/ajax-actions.php

Ajax handler for saving the meta box order.
wp_ajax_find_posts() wp-admin/includes/ajax-actions.php

Ajax handler for querying posts for the Find Posts modal.
Custom_Image_Header::ajax_header_crop() wp-admin/includes/class-custom-image-header.php

Gets attachment uploaded by Media Manager, crops it, then saves it as a new object. Returns JSON-encoded object details.
Custom_Image_Header::ajax_header_add() wp-admin/includes/class-custom-image-header.php

Given an attachment ID for a header image, updates its “last used” timestamp to now.
Custom_Image_Header::ajax_header_remove() wp-admin/includes/class-custom-image-header.php

Given an attachment ID for a header image, unsets it as a user-uploaded header image for the active theme.
WP_Customize_Manager::save() wp-includes/class-wp-customize-manager.php

Handles customize_save WP Ajax request to save/update a changeset.
WP_Customize_Widgets::wp_ajax_update_widget() wp-includes/class-wp-customize-widgets.php

Updates widget settings asynchronously.
Show 55 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
5.6.0 The $options parameter was added.
4.7.0 The $status_code parameter was added.
3.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Andrew Lima —

    Busy working on sending JSON requests back to Zapier, here’s an example to help people get started. You can send an associative array of any data you need to get returned/shown.

    wp_send_json_success( array( 
    'name' => 'Andrew', 
    'call' => 'From some API/trigger', 
    'variable' => $var,
), 200 );
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Basic Example

    jQuery( document ).ready( function() {

	jQuery( '#btn_save' ).click( function( e ) {
		e.preventDefault();
		jQuery.post( pluginUrl+ 'ajax/save_field.php', 
			jQuery( '#my-form' ).serialize(), function( data ) {                        
				alert( data.message ); 
			}
		);
	} );
} );

    save_field.php:

    // Bootstrap WP

$return = array(
	'message' => __( 'Saved', 'textdomain' ),
	'ID'      => 1
);
wp_send_json_success( $return );

You must log in before being able to contribute a note or feedback.