is_wp_error() WP 2.1

Проверяет переданную переменную является ли она специальной ошибкой (объектом WP_Error).

Используется в WP для проверки ошибки, для функций, которые генерируют специальную ошибку с помощью класса WP_Error. Такие ошибки имеют описание, чтобы проще было разобраться в причине. Например, такая ошибка вернется функцией wp_insert_term(), далее посмотрев описание ошибки, легко можно будет понять из-за чего не работает функция.

Хуков нет.

Возвращает

true/false.

Использование

if( is_wp_error( $thing ) ){
	echo $thing->get_error_message(); // сообщение ошибки
	echo $thing->get_error_code(); // ключ ошибки
}

$thing(строка/массив/объект) (обязательный)

Любая перемененная, которая может выглядеть как ошибка ВП или нет.
По умолчанию: нет

Примеры

#1 Захват ошибки в WP

Пример обработки ошибки WordPress передаваемой в объекте WP_Error. Если ошибка указана, то выведем на экран сообщение о ней:

// $result - переменная которая может содержать ошибку.

if( is_wp_error( $result ) ) {
	$error_string = $result->get_error_message();

	echo '<div id="message" class="error"><p>' . $error_string . '</p></div>';

	echo $res->get_error_code(); // -> error или другой ключ ошибки
}

Код is_wp_error: wp-includes/load.php ^{VER 5.0.1}

<?php
function is_wp_error( $thing ) {
	return ( $thing instanceof WP_Error );
}

Cвязанные функции

Из раздела: Без рубрики