Вирішення проблем з зачисткою вмісту API WordPress

Чому ваші повідомлення API WordPress REST втрачають вміст

Як розробник, ви, ймовірно, зіткнулися з розчаруванням використання API WordPress Rest для створення власних публікацій, лише щоб знайти цю частину вмісту, загадково зникло. Ця проблема може бути особливо дратуючим, коли ви впевнені, що вхід є правильним, але WordPress не робить його, як очікувалося.

Цей конкретний виклик часто виникає при використанні розширених блоків або плагінів, таких як Kadence. У багатьох випадках WordPress застосовує внутрішні фільтри або процеси санітарії, які позбавляють непідтримуваного або неправильно відформатованого вмісту. Проблема стає ще складнішою, коли задіяні динамічні блоки або спеціальні налаштування.

Уявіть, що витрачаєте години, вдосконалюючи компонування з фоновими зображеннями, унікальними ідентифікаторами та чуйними налаштуваннями, лише щоб побачити ті ретельно розроблені деталі, що зникають у повітря. Це звичайний сценарій для розробників, що покладаються на такі плагіни, як Kadence, щоб доставити багаті макети через API REST.

Але не хвилюйтеся, це не розволі таємниця. Розуміючи, як WordPress обробляє санітарію вмісту та застосовуючи кілька найкращих практик, ви можете забезпечити, щоб ваші виклики API забезпечували потрібні результати без будь -яких небажаних сюрпризів. 🚀 Давайте зануримось, як виправити це раз і назавжди!

Як запобігти зачистку вмісту в API REST WordPress

Перше рішення, яке я представив, передбачає використання rest_pre_insert_post Фільтр у WordPress. Цей фільтр дозволяє розробникам змінювати дані публікації до збереження в базі даних через API REST. Звернувшись до цього фільтра, ви можете перекрити поведінку санітарії за замовчуванням WordPress та вставити сирий вміст точно за призначенням. Наприклад, у сценарії ми перевіряємо наявність користувальницького поля під назвою "content_raw" у запиті API, гарантуючи, що сирий вміст HTML зберігається без позбавлення. Це особливо корисно для таких плагінів, як Kadence, де макет покладається на власні блокові структури та метадані. 🚀

Друге рішення вводить спеціальну кінцеву точку API REST за допомогою register_rest_route. Цей метод дає розробникам повний контроль над тим, як обробляються та зберігаються дані публікації. У цій користувальницькій кінцевій точці вміст RAW із запиту API безпосередньо передається в базу даних WordPress за допомогою wp_insert_post функція. Це обходить фільтри API REST за замовчуванням і забезпечує складні конфігурації HTML або блоку без змін. Наприклад, спеціальний макет, створений за допомогою блоків Kadence, залишатиметься недоторканим, навіть якщо він включає в себе вдосконалені налаштування, такі як фонові зображення або чуйні макети.

На фронтді я продемонстрував, як використовувати JavaScript для подання запитів API під час збереження необробленого вмісту. Приклад використовує витягувати API, сучасний спосіб обробки HTTP -запитів у JavaScript. У цьому сценарії вміст RAW HTML передається в параметрі "Вміст" запиту на публікацію, а автентифікація обробляється через ім’я користувача та пароль Base64 у Дозвіл заголовок. Цей метод є важливим для розробників, які будують інтерактивні або динамічні фронти, які повинні підштовхнути сирий вміст до WordPress, не покладаючись на інтерфейс адміністратора.

Усі сценарії включають критичні функції, такі як обробка помилок та перевірка введення, щоб переконатися, що вони працюють правильно в реальних сценаріях. Наприклад, спеціальна кінцева точка використовує IS_WP_ERROR Функція для виявлення та обробки помилок, надання значущих відгуків, якщо щось піде не так. Цей підхід гарантує, що розробники можуть швидко вирішити проблеми, забезпечуючи безперебійну доставку вмісту. Уявіть, що створити візуально приголомшливий макет пошти для клієнта, лише щоб знайти його частково позбавленим у WordPress - ці сценарії гарантують, що ніколи не трапляється! 🛠

// Solution 1: Disable REST API content sanitization and allow raw HTML// Add this code to your WordPress theme's functions.php file<code>add_filter('rest_pre_insert_post', function ($data, $request) {
    // Check for specific custom post type or route
    if (isset($request['content_raw'])) {
        $data['post_content'] = $request['content_raw']; // Set the raw content
    }
    return $data;
}, 10, 2);

// Make sure you’re passing the raw content in your request
// Example POST request:
// In your API request, ensure `content_raw` is passed instead of `content`.
let data = {
    title: 'My Post Title',
    content_raw: my_post,
    status: 'draft'
};
// Send via an authenticated REST client

// Add this code to your theme's functions.php or a custom plugin file<code>add_action('rest_api_init', function () {
    register_rest_route('custom/v1', '/create-post', array(
        'methods' => 'POST',
        'callback' => 'custom_create_post',
        'permission_callback' => '__return_true',
    ));
});
function custom_create_post($request) {
    $post_data = array(
        'post_title' => sanitize_text_field($request['title']),
        'post_content' => $request['content'], // Raw content passed here
        'post_status' => $request['status'],
    );
    $post_id = wp_insert_post($post_data);
    if (is_wp_error($post_id)) {
        return new WP_Error('post_error', 'Failed to create post', array('status' => 500));
    }
    return new WP_REST_Response(array('post_id' => $post_id), 200);
}

// Example using JavaScript to post raw content via the WordPress REST API<code>const rawContent = `<!-- wp:kadence/rowlayout {\"uniqueID\":\"5331_605d8b-3f\"} -->`;
const data = {
    title: "My Custom Post",
    content: rawContent,
    status: "draft"
};
fetch('https://mywp.xyz/wp-json/wp/v2/posts', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Basic ' + btoa('username:password')
    },
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Розуміння обробки вмісту API WordPress

API WordPress REST - це потужний інструмент, який дозволяє розробникам створювати, читати, оновлювати та видаляти публікації програмно. Однак одним з менш розбіжних аспектів є те, як WordPress обробляє вміст, перш ніж зберегти його в базі даних. Використовуючи API REST, WordPress застосовує ряд фільтрів та кроків санітарії, щоб забезпечити безпечний та сумісний з його внутрішніми системами. Хоча це відмінно підходить для безпеки, це може спричинити проблеми для розробників, які працюють з користувальницькими HTML або блоками від таких плагінів, як Kadence. Наприклад, складні макети з спеціальними метаданими або конфігураціями блоку можуть бути частково позбавлені, оскільки WordPress їх інтерпретує неправильно. 🛠

Ще одним критичним фактором є те, як API REST взаємодіє з динамічні блоки. Ці блоки надаються на фронтді, використовуючи PHP, а не зберігатися як статичний HTML. Якщо ваш спеціальний блок не зареєстрований належним чином або API не розпізнає його, деякі ваші конфігурації блоку можуть не зберегти правильно. Це відбувається тому, що WordPress намагається проаналізувати та підтвердити розмітку блоку під час процесу збереження, що може ненавмисно зняти важливі частини вашого вмісту. Щоб запобігти цьому, важливо використовувати належну реєстрацію блоку з атрибутами, які відповідають вашому вмісту API.

Для вирішення цих викликів розробники часто обходять стандартні фільтри API REST, створюючи спеціальні кінцеві точки або переважаючи конкретну поведінку WordPress. Наприклад, використання фільтрів, таких як rest_pre_insert_post Дозволяє вводити сирий HTML без перешкод. Ретельно пошикувавши ці рішення, ви можете працювати навколо обробки за замовчуванням WordPress та переконатися, що ваші складні макети та конструкції залишаються недоторканими. Уявіть собі, що створити приголомшливий банер з блоком Kadence, лише щоб побачити його неправильно на передній частині - ці рішення заважають це статися! 🚀