rest_convert_error_to_response() │ WP 5.7.0

Converts an error to a response object.

This iterates over all error codes and messages to change it into a flat array. This enables simpler client behavior, as it is represented as a list in JSON rather than an object/map.

No Hooks.

Returns

WP_REST_Response. List of associative arrays with code and message keys.

Usage

rest_convert_error_to_response( $error );

$error(WP_Error) (required)

WP_Error instance.

Changelog

rest_convert_error_to_response() rest convert error to response code ^{WP 7.0}

function rest_convert_error_to_response( $error ) {
	$status = array_reduce(
		$error->get_all_error_data(),
		/**
		 * @param int   $status     Status.
		 * @param mixed $error_data Error data.
		 */
		static function ( int $status, $error_data ): int {
			if ( is_array( $error_data ) && isset( $error_data['status'] ) && is_numeric( $error_data['status'] ) ) {
				$status = (int) $error_data['status'];
			}
			return $status;
		},
		500
	);

	$errors = array();

	foreach ( (array) $error->errors as $code => $messages ) {
		$all_data  = $error->get_all_error_data( $code );
		$last_data = array_pop( $all_data );

		foreach ( (array) $messages as $message ) {
			$formatted = array(
				'code'    => $code,
				'message' => $message,
				'data'    => $last_data,
			);

			if ( $all_data ) {
				$formatted['additional_data'] = $all_data;
			}

			$errors[] = $formatted;
		}
	}

	$data = $errors[0];
	if ( count( $errors ) > 1 ) {
		// Remove the primary error.
		array_shift( $errors );
		$data['additional_errors'] = $errors;
	}

	return new WP_REST_Response( $data, $status );
}