Описание функции wp_update_post()
Функция wp_update_post() обновляет существующую запись в базе данных WordPress. Она позволяет изменять различные поля записи, такие как заголовок, содержание, статус и другие метаданные. Функция возвращает ID обновленной записи или WP_Error в случае ошибки.
Используется для программного изменения свойств записей, что может быть полезно в плагинах, темах или при разработке REST API.
Параметры
$postarr
Тип: array
Обязательный: Да
По умолчанию: array()
Описание: Массив данных записи, которую необходимо обновить.
Возможные значения:
ID: ID записи
post_title: Заголовок записи
post_content: Содержимое записи
post_excerpt: Краткое содержание записи
post_status: publish, draft, pending, private, trash
post_type: Тип записи
post_date: Дата создания записи
post_date_gmt: GMT дата создания записи
post_author: ID автора записи
Возвращаемое значение
Тип: int|WP_Error
Описание: Возвращает ID обновленной записи или WP_Error в случае ошибки.
Возможные значения:
• ID обновленной записи при успешном выполнении
• WP_Error в случае ошибки
Примеры использования
Базовый пример обновления заголовка и содержания записи с ID 1
$post_id = wp_update_post(array(
'ID' => 1,
'post_title' => 'Новый заголовок',
'post_content' => 'Новое содержание'
));
// $post_id будет равен ID обновленной записи
Обновление статуса и краткого содержания записи с ID 2
$post_id = wp_update_post(array(
'ID' => 2,
'post_status' => 'draft',
'post_excerpt' => 'Краткое содержание'
));
// Запись с ID 2 будет переведена в черновик
Обработка ошибки при попытке обновления несуществующей записи
$post_id = wp_update_post(array(
'ID' => 9999,
'post_title' => 'Не существующая запись'
));
if (is_wp_error($post_id)) {
echo 'Ошибка: ' . $post_id->get_error_message();
}
Безопасность
Валидация входных данных: ID записи и другие параметры проверяются на соответствие требованиям.
Санитизация: WordPress автоматически очищает входные данные перед обновлением.
Рекомендации: При выводе данных используйте функции экранирования, например, esc_html() для заголовков и содержимого.
— Связанные функции
Создает новую запись или обновляет существующую, если указано ID.
Получает данные конкретной записи по ID.
— Хуки
Фильтрует данные записи перед ее обновлением.
— Примечания
– Ограничения
ID записи должен существовать для успешного обновления.
– Частые проблемы
- Ошибка при неправильном ID записи.
- Проблемы с правами доступа для обновления записи.
