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

Description

Parameters

$valuemixedoptional

Data to encode as JSON, then print and die. Default null.Default: null

$status_codeintoptional

The HTTP status code to output. Default null.Default: null

$flagsintoptional

Options to be passed to json_encode(). Default 0.Default: 0

Uses · 2

• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_send_json()Sends a JSON response back to an Ajax request.

Used by · 50

• Custom_Background::ajax_background_add()Handles Ajax request for adding custom background context to an attachment.
• Custom_Image_Header::ajax_header_add()Given an attachment ID for a header image, updates its "last used" timestamp to now.
• Custom_Image_Header::ajax_header_crop()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_remove()Given an attachment ID for a header image, unsets it as a user-uploaded header image for the active theme.
• WP_Customize_Manager::handle_changeset_trash_request()Handles request to trash a changeset.
• WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
• WP_Customize_Manager::handle_load_themes_request()Loads themes into the theme browsing/installation UI.
• WP_Customize_Manager::handle_override_changeset_lock_request()Removes changeset lock when take over request is sent via Ajax.
• WP_Customize_Manager::refresh_nonces()Refreshes nonces for the current preview.
• WP_Customize_Manager::save()Handles customize_save WP Ajax request to save/update a changeset.
• WP_Customize_Nav_Menus::ajax_insert_auto_draft_post()Ajax handler for adding a new auto-draft post.
• WP_Customize_Nav_Menus::ajax_load_available_items()Ajax handler for loading available menu items.

Source

View on Trac ↗View on GitHub ↗

4614function wp_send_json_error( $value = null, $status_code = null, $flags = 0 ) {4615	$response = array( 'success' => false );4616 4617	if ( isset( $value ) ) {4618		if ( is_wp_error( $value ) ) {4619			$result = array();4620			foreach ( $value->errors as $code => $messages ) {4621				foreach ( $messages as $message ) {4622					$result[] = array(4623						'code'    => $code,4624						'message' => $message,4625					);4626				}4627			}4628 4629			$response['data'] = $result;4630		} else {4631			$response['data'] = $value;4632		}4633	}4634 4635	wp_send_json( $response, $status_code, $flags );4636}

History

Introduced in 3.5.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.