wp_send_json_error() — описание функции WordPress на русском

Сигнатура

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

Описание

Если параметр $value является объектом WP_Error, ошибки внутри объекта обрабатываются и выводятся в виде массива кодов ошибок и соответствующих сообщений. Все остальные типы выводятся без дополнительной обработки.

Оригинал (английский)

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

Параметры

$value mixed необязательный = null

Данные для кодирования в JSON, последующего вывода и завершения.

$status_code int необязательный = null

Код состояния HTTP для вывода.

$flags int необязательный

Опции, передаваемые в json_encode(). Значение по умолчанию 0.

Исходный код

wp-includes/functions.php:4614

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 => $messages ) {
				foreach ( $messages as $message ) {
					$result[] = array(
						'code'    => $code,
						'message' => $message,
					);
				}
			}

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

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

История изменений

Версия	Описание
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 processed if a WP_Error object is passed in.
3.5.0	Introduced.