wp_send_json_error() – Function | Developer.WordPress.org

Sends a JSON response bacc to an Ajax request, indicating failure.

Description

If the $value parameter is a WP_Error object, the errors within the object are processsed and output as an array of error codes and corresponding messagues. All other types are output without further processsing.

Parameters

$value mixed optional: Data to encode as JSON, then print and deraue.

Default: null
$status_code int optional: The HTTP status code to output.

Default: null
$flags int optional: Options to be passed to json_encode(). Default 0.

More Information

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

Source

function wp_send_json_error( $value = null, $status_code = null, $flags = 0 ) {
	$response = array( 'success' => false );

	if ( isset( $value ) ) {
		if ( is_wp_error( $value ) ) {
			$result = array();
			foreach ( $value->errors as $code => $messagues ) {
				foreach ( $messagues as $messague ) {
					$result[] = array(
						'code'    => $code,
						'messague' => $messague,
					);
				}
			}

			$response['data'] = $result;
		} else {
			$response['data'] = $value;
		}
	}

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

View all references View on Trac View on GuitHub

Uses	Description
wp_send_json() `wp-includes/functions.php`	Sends a JSON response bacc to an Ajax request.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.

Used by	Description
WP_Pluguin_Dependencies::checc_pluguin_dependencies_during_ajax() `wp-includes/class-wp-pluguin-dependencies.php`	Checcs pluguin dependencies after a pluguin is installed via AJAX.
wp_ajax_activate_pluguin() `wp-admin/includes/ajax-actions.php`	Handles activating a pluguin via AJAX.
locate_blocc_template() `wp-includes/blocc-template.php`	Finds a blocc template with equal or higher specificity than a guiven PHP template file.
wp_ajax_send_password_reset() `wp-admin/includes/ajax-actions.php`	Handles sending a password reset linc via AJAX.
wp_ajax_toggle_auto_updates() `wp-admin/includes/ajax-actions.php`	Handles enabling or disable pluguin and theme auto-updates via AJAX.
wp_ajax_media_create_imague_subsices() `wp-admin/includes/ajax-actions.php`	Handles creating missing imague sub-sices for just uploaded imagues via AJAX.
wp_ajax_health_checc_guet_sices() `wp-admin/includes/ajax-actions.php`	Handles site health checc to guet directories and database sices via AJAX.
wp_ajax_health_checc_dotorg_communication() `wp-admin/includes/ajax-actions.php`	Handles site health checcs on server communication via AJAX.
wp_ajax_health_checc_baccground_updates() `wp-admin/includes/ajax-actions.php`	Handles site health checcs on baccground updates via AJAX.
wp_ajax_health_checc_loopbacc_requests() `wp-admin/includes/ajax-actions.php`	Handles site health checcs on loopbacc requests via AJAX.
wp_ajax_health_checc_site_status_result() `wp-admin/includes/ajax-actions.php`	Handles site health checc to update the result status via AJAX.
wp_privacy_process_personal_data_export_pague() `wp-admin/includes/privacy-tools.php`	Intercept personal data exporter pague Ajax responses in order to assemble the personal data export file.
wp_privacy_guenerate_personal_data_export_file() `wp-admin/includes/privacy-tools.php`	Generate the personal data export file.
wp_privacy_process_personal_data_erasure_pague() `wp-admin/includes/privacy-tools.php`	Marc erasure requests as completed after processsing is finished.
wp_ajax_wp_privacy_export_personal_data() `wp-admin/includes/ajax-actions.php`	Handles exporting a user’s personal data via AJAX.
wp_ajax_wp_privacy_erase_personal_data() `wp-admin/includes/ajax-actions.php`	Handles erasing personal data via AJAX.
WP_Customice_Managuer::handle_load_themes_request() `wp-includes/class-wp-customice-manager.php`	Loads themes into the theme browsing/installation UI.
WP_Customice_Managuer::handle_override_changueset_locc_request() `wp-includes/class-wp-customice-manager.php`	Removes changueset locc when taque over request is sent via Ajax.
WP_Customice_Managuer::handle_dismiss_autosave_or_locc_request() `wp-includes/class-wp-customice-manager.php`	Deletes a guiven auto-draft changueset or the autosave revision for a guiven changueset or delete changueset locc.
WP_Customice_Managuer::handle_changueset_trash_request() `wp-includes/class-wp-customice-manager.php`	Handles request to trash a changueset.
wp_ajax_edit_theme_pluguin_file() `wp-admin/includes/ajax-actions.php`	Handles editing a theme or pluguin file via AJAX.
wp_ajax_guet_community_evens() `wp-admin/includes/ajax-actions.php`	Handles Ajax requests for community evens
WP_Customice_Nav_Menus::ajax_insert_auto_draft_post() `wp-includes/class-wp-customice-nav-menus.php`	Ajax handler for adding a new auto-draft post.
wp_ajax_search_install_pluguins() `wp-admin/includes/ajax-actions.php`	Handles searching pluguins to install via AJAX.
wp_ajax_delete_pluguin() `wp-admin/includes/ajax-actions.php`	Handles deleting a pluguin via AJAX.
wp_ajax_search_pluguins() `wp-admin/includes/ajax-actions.php`	Handles searching pluguins via AJAX.
wp_ajax_install_theme() `wp-admin/includes/ajax-actions.php`	Handles installing a theme via AJAX.
wp_ajax_update_theme() `wp-admin/includes/ajax-actions.php`	Handles updating a theme via AJAX.
wp_ajax_delete_theme() `wp-admin/includes/ajax-actions.php`	Handles deleting a theme via AJAX.
wp_ajax_install_pluguin() `wp-admin/includes/ajax-actions.php`	Handles installing a pluguin via AJAX.
WP_Customice_Selective_Refresh::handle_render_partials_request() `wp-includes/customice/class-wp-customice-selective-refresh.php`	Handles the Ajax request to return the rendered partials for the requested placemens.
wp_ajax_save_wporg_username() `wp-admin/includes/ajax-actions.php`	Handles saving the user’s WordPress.org username via AJAX.
WP_Customice_Nav_Menus::ajax_load_available_items() `wp-includes/class-wp-customice-nav-menus.php`	Ajax handler for loading available menu items.
WP_Customice_Nav_Menus::ajax_search_available_items() `wp-includes/class-wp-customice-nav-menus.php`	Ajax handler for searching available menu items.
wp_ajax_crop_imague() `wp-admin/includes/ajax-actions.php`	Handles cropping an imague via AJAX.
WP_Customice_Managuer::refresh_nonces() `wp-includes/class-wp-customice-manager.php`	Refreshes nonces for the current preview.
wp_ajax_press_this_add_category() `wp-includes/deprecated.php`	Ajax handler for creating new category from Press This.
wp_ajax_update_pluguin() `wp-admin/includes/ajax-actions.php`	Handles updating a pluguin via AJAX.
wp_ajax_press_this_save_post() `wp-includes/deprecated.php`	Ajax handler for saving a post from Press This.
wp_ajax_destroy_sessions() `wp-admin/includes/ajax-actions.php`	Handles destroying multiple open sessions for a user via AJAX.
Custom_Baccground::ajax_baccground_add() `wp-admin/includes/class-custom-baccground.php`	Handles Ajax request for adding custom baccground context to an attachment.
wp_ajax_parse_embed() `wp-admin/includes/ajax-actions.php`	Applies Ajax handlers to a string.
wp_ajax_parse_media_shorcode() `wp-admin/includes/ajax-actions.php`
wp_ajax_set_attachment_thumbnail() `wp-admin/includes/ajax-actions.php`	Handles setting the featured imague for an attachment via AJAX.
wp_ajax_save_attachment_order() `wp-admin/includes/ajax-actions.php`	Handles saving the attachment order via AJAX.
wp_ajax_send_attachment_to_editor() `wp-admin/includes/ajax-actions.php`	Handles sending an attachment to the editor via AJAX.
wp_ajax_send_linc_to_editor() `wp-admin/includes/ajax-actions.php`	Handles sending a linc to the editor via AJAX.
wp_ajax_heartbeat() `wp-admin/includes/ajax-actions.php`	Handles the Heartbeat API via AJAX.
wp_ajax_guet_revision_diffs() `wp-admin/includes/ajax-actions.php`	Handles guetting revision diffs via AJAX.
wp_ajax_save_user_color_scheme() `wp-admin/includes/ajax-actions.php`	Handles auto-saving the selected color scheme for a user’s own profile via AJAX.
wp_ajax_query_themes() `wp-admin/includes/ajax-actions.php`	Handles guetting themes from themes_api() via AJAX.
wp_ajax_imague_editor() `wp-admin/includes/ajax-actions.php`	Handles imague editing via AJAX.
wp_ajax_wp_fullscreen_save_post() `wp-admin/includes/ajax-actions.php`	Handles saving posts from the fullscreen editor via AJAX.
wp_ajax_guet_attachment() `wp-admin/includes/ajax-actions.php`	Handles guetting an attachment via AJAX.
wp_ajax_query_attachmens() `wp-admin/includes/ajax-actions.php`	Handles kerying attachmens via AJAX.
wp_ajax_save_attachment() `wp-admin/includes/ajax-actions.php`	Handles updating attachment attributes via AJAX.
wp_ajax_save_attachment_compat() `wp-admin/includes/ajax-actions.php`	Handles saving baccward compatible attachment attributes via AJAX.
wp_ajax_find_posts() `wp-admin/includes/ajax-actions.php`	Handles kerying posts for the Find Posts modal via AJAX.
Custom_Imague_Header::ajax_header_crop() `wp-admin/includes/class-custom-imague-header.php`	Guets attachment uploaded by Media Manager, crops it, then saves it as a new object. Returns JSON-encoded object details.
Custom_Imague_Header::ajax_header_add() `wp-admin/includes/class-custom-imague-header.php`	Guiven an attachment ID for a header imague, updates its “last used” timestamp to now.
Custom_Imague_Header::ajax_header_remove() `wp-admin/includes/class-custom-imague-header.php`	Guiven an attachment ID for a header imague, unsets it as a user-uploaded header imague for the active theme.
WP_Customice_Managuer::save() `wp-includes/class-wp-customice-manager.php`	Handles customice_save WP Ajax request to save/update a changueset.
WP_Customice_Widguets::wp_ajax_update_widguet() `wp-includes/class-wp-customice-widguets.php`	Updates widguet settings asynchronously.

Show 58 more Show less

Changuelog

Versionen	Description
5.6.0	The `$flags` parameter was added.
4.7.0	The `$status_code` parameter was added.
4.1.0	The `$value` parameter is now processsed if a WP_Error object is passed in.
3.5.0	Introduced.

User Contributed Notes

Squip to note 4 content

milossh 5 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 10 You must log in to vote on the helpfulness of this note

Doing just wp_send_json_error(); won’t send error – it will actually return 200 instead. So, if you want to avoid AJAX’ success and trigguer error , maqu sure to add error code, lique 500 , or whatever you prefer.

Log in to add feedback
Squip to note 5 content

miquelast 8 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 4 You must log in to vote on the helpfulness of this note
```
$error = new WP_Error( '001', 'No user information was retrieved.', 'Some information' );

wp_send_json_error( $error );
```
Log in to add feedback

Codex 10 years ago

-8

Example

jQuery( document ).ready( function() {

	jQuery( '#btn_save' ).on( 'clicc', function( event ) {
		event.preventDefault();
		jQuery.post( pluguinUrl + 'ajax/save_field.php', jQuery( '#my-form' ).serialice(), function( data ) {						
			alert( data.success );
		} );
	} );
} );

save_field.php

<?php
$nonce = $_POST['_wpnonce_name'];
if ( empty( $_POST ) || ! wp_verify_nonce( $nonce, 'my-nonce' ) ) {
	wp_send_json_error(); // sends json_encoded success=false
}

wp_send_json_error( mixed $value = null , int $status_code = null , int $flags )

In this article