is_wp_error() │ WP 2.1.0

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

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

Хуки из функции

is_wp_error_instance

Возвращает

true|false.

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

if( is_wp_error( $thing ) ){
	// error
}

$thing(строка/массив/объект) (обязательный): Любая перемененная, которая может выглядеть как ошибка (объект WP_Error).

Примеры

#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 или другой ключ ошибки
}

Список изменений

С версии 2.1.0

Введена.

Код `is_wp_error() is wp error` ^{WP 6.5.2}

wp-includes/load.php

function is_wp_error( $thing ) {
	$is_wp_error = ( $thing instanceof WP_Error );

	if ( $is_wp_error ) {
		/**
		 * Fires when `is_wp_error()` is called and its parameter is an instance of `WP_Error`.
		 *
		 * @since 5.6.0
		 *
		 * @param WP_Error $thing The error object passed to `is_wp_error()`.
		 */
		do_action( 'is_wp_error_instance', $thing );
	}

	return $is_wp_error;
}