Функция wp_delete_comment()
в WordPress используется для удаления комментария из базы данных. Она выполняет удаление указанного комментария и всех связанных метаданных, а также удаляет комментарий из кеша. Функция удобна для удаления как одиночных комментариев, так и массового удаления.
wp_delete_comment( $comment_id, $force_delete );
Параметры
- $comment_id (int, обязательный)
ID комментария, который нужно удалить. - $force_delete(bool, необязательный)
Определяет, следует ли принудительно удалить комментарий из базы данных.- По умолчанию:
false
— комментарий будет перемещен в корзину (если поддерживается). true
— комментарий будет удален из базы данных без возможности восстановления.
- По умолчанию:
Возвращаемое значение
(bool|WP_Error)
Возвращает true
в случае успешного удаления комментария. Возвращает false
в случае ошибки или если комментарий не найден. Если переданный комментарий является неправильным объектом, возвращается объект WP_Error
.
Пример1: Удаление комментария по ID без использования корзины
$comment_id = 42;
$deleted = wp_delete_comment( $comment_id, true );
if ( $deleted ) {
echo "Комментарий успешно удален.";
} else {
echo "Ошибка при удалении комментария.";
}
Этот код удаляет комментарий с ID 42 из базы данных, минуя корзину. Если удаление прошло успешно, выведется сообщение «Комментарий успешно удален».
Пример 2: Удаление комментария с перемещением в корзину
$comment_id = 56;
$deleted = wp_delete_comment( $comment_id );
if ( $deleted ) {
echo "Комментарий перемещен в корзину.";
} else {
echo "Ошибка при удалении комментария.";
}
Этот пример перемещает комментарий с ID 56 в корзину. Функция возвращает true
, если комментарий был успешно перемещен, и false
в случае ошибки.
Важные замечания
- Если опция
$force_delete
установлена вfalse
, комментарий будет перемещен в корзину, если корзина поддерживается в вашей установке WordPress. Если корзина не поддерживается, комментарий будет удален полностью. - После удаления комментария, связанный с ним кэш будет также сброшен.
Связанные функции
wp_trash_comment()
: Перемещает комментарий в корзину.wp_untrash_comment()
: Восстанавливает комментарий из корзины.wp_insert_comment()
: Вставляет новый комментарий в базу данных.
Заключение
Функция wp_delete_comment()
полезна для ситуаций, когда необходимо безопасно и эффективно управлять удалением комментариев на вашем сайте.