Проверка ошибки в WordPress с помощью функции IS_WP_ERROR()

Что такое IS_WP_ERROR()?

Функция is_wp_error() была введена в версии WordPress 2.1.0. Она используется для проверки, является ли переданная переменная объектом ошибки WordPress. Ошибки WordPress имеют описание, с помощью которого можно понять, что пошло не так.

Например, функция wp_insert_term() может вернуть ошибку WP_Error, и вы можете использовать её описание для выяснения причины проблемы.

Возвращаемое значение

Функция возвращает значение true или false:

• true — если переменная является экземпляром WP_Error.
• false — если переменная не является ошибкой.

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

Синтаксис функции такой:

is_wp_error( $thing );

Где:

• $thing (необязательный) — это переменная, которую нужно проверить.

Примеры использования

Пример 1: Обработка ошибки WordPress

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

// $result - это какая-то переменная, которая может быть WP_Error.

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

    echo '
' . $error_string . '
';
    echo $result->get_error_code(); // Например, 'error' или другой код ошибки
}

Пример 2: Пример с WP_INSERT_USER()

Мы можем использовать is_wp_error() также и с функцией для добавления пользователя. Например:

$email = 'example@example.com';
$userdata = [
    'user_login' => $email,
    'user_email' => $email,
];

$user_id = wp_insert_user( $userdata );

if ( is_wp_error( $user_id ) ) {
    $error_message = $user_id->get_error_message();
    echo 'Ошибка при добавлении пользователя: ' . $error_message;
}

Как работает функция?

Вот код функции is_wp_error() из файла wp-includes/load.php:

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

    if ( $is_wp_error ) {
        /**
         * Срабатывает, когда вызывается is_wp_error() и её параметр является экземпляром WP_Error.
         *
         * @since 5.6.0
         *
         * @param WP_Error $thing Объект ошибки, переданный в is_wp_error().
         */
        do_action( 'is_wp_error_instance', $thing );
    }

    return $is_wp_error;
}

Функция проверяет, является ли переданная переменная экземпляром класса WP_Error. Если это так, она вызывает событие do_action, позволяя другим частям кода реагировать на это.

Заключение

Функция is_wp_error() в WordPress — это простой и эффективный способ проверить наличие ошибок в ваших данных. С помощью этого инструмента разработчики могут обрабатывать ошибки более грамотно, отображая соответствующие сообщения для пользователей. Пользуйтесь этой функцией, чтобы улучшить качество вашего кода и пользовательский опыт.