Riešenie problémov s odstraňovaním obsahu WordPress REST API

Prečo vaše príspevky API WordPress REST API strácajú obsah

Ako vývojár ste pravdepodobne narazili na frustráciu z použitia rozhrania API WordPress REST na vytvorenie vlastných príspevkov, len aby ste zistili, že časť vášho obsahu záhadne zmizla. Tento problém môže byť obzvlášť nepríjemný, keď ste si istí, že vstup je správny, ale spoločnosť WordPress ho nepredstavuje podľa očakávania.

Táto špecifická výzva často vzniká pri používaní pokročilých blokov alebo doplnkov, ako je Kadence. V mnohých prípadoch WordPress uplatňuje interné filtre alebo procesy sanitizácie, ktoré vylučujú nepodporovaný alebo nesprávne formátovaný obsah. Problém sa stáva ešte zložitejším, keď sú zapojené dynamické bloky alebo vlastné nastavenia.

Predstavte si, že trávite hodiny zdokonaľovaním rozloženia s obrázkami na pozadí, jedinečnými ID a responzívnymi nastaveniami, len aby ste videli tieto starostlivo navrhnuté detaily zmiznuté do tenkého vzduchu. Je to bežný scenár pre vývojárov, ktorí sa spoliehajú na doplnky, ako je Kadence, aby poskytovali bohaté rozloženia prostredníctvom API REST.

Ale nebojte sa, toto nie je neriešiteľné tajomstvo. Pochopením toho, ako WordPress rieši dezinizáciu obsahu a uplatňuje niekoľko osvedčených postupov, môžete zabezpečiť, aby vaše hovory API priniesli požadované výsledky bez akýchkoľvek nevítaných prekvapení. 🚀 Poďme sa ponoriť do toho, ako to napraviť raz a navždy!

Ako zabrániť odstraňovaniu obsahu v rozhraní WordPress Rest API

Prvé riešenie, ktoré som uviedol, zahŕňa použitie rest_pre_insert_post filter v WordPress. Tento filter umožňuje vývojárom upravovať údaje príspevkov skôr, ako sa uložia do databázy prostredníctvom API REST. Pripnutím do tohto filtra môžete prepísať predvolené dezinfikačné správanie spoločnosti WordPress a vložiť prvotný obsah presne podľa plánu. Napríklad v skripte skontrolujeme vlastné pole s názvom „content_raw“ v žiadosti API, čím sa zabezpečí, že obsah RAW HTML sa zachoval bez toho, aby bol odstránený. Toto je užitočné najmä pre doplnky ako Kadence, kde sa rozloženie spolieha na vlastné blokové štruktúry a metadáta. 🚀

Druhé riešenie zavádza koncový bod REST REST API pomocou register_rest_route. Táto metóda poskytuje vývojárom úplnú kontrolu nad tým, ako sa údaje post spracujú a ukladajú. V tomto vlastnom koncovom bode sa obsah nespracuje z požiadavky API priamo odovzdáva do databázy WordPress pomocou wp_insert_post funkcia. Tým sa obchádza predvolené filtre REST API a zaisťuje, že komplexné konfigurácie HTML alebo bloku sa ukladajú bez úpravy. Napríklad vlastné rozloženie vytvorené s blokmi Kadence zostane nedotknuté, aj keď obsahuje pokročilé nastavenia, ako sú obrázky na pozadí alebo responzívne rozloženia.

Na frontend som demonštroval, ako používať JavaScript na požiadavky API pri zachovaní surového obsahu. Príklad používa vyvolať API, moderný spôsob riešenia požiadaviek HTTP v JavaScripte. V tomto scenári sa obsah RAW HTML odovzdáva v parametri „obsahu“ žiadosti o príspevok a autentifikácia sa rieši prostredníctvom užívateľského mena a hesla kódovaného základne64 v Base64. Oprávnenie hlavička. Táto metóda je nevyhnutná pre vývojárov, ktorí budujú interaktívne alebo dynamické fronty, ktoré musia tlačiť surový obsah do WordPress bez spoliehania sa na rozhranie správcu.

Všetky skripty obsahujú kritické funkcie, ako je manipulácia s chybami a validácia vstupov, aby sa zabezpečilo, že správne fungujú v scenároch v reálnom svete. Napríklad vlastný koncový bod používa is_wp_error Funkcia na detekciu a spracovanie chýb a poskytuje zmysluplnú spätnú väzbu, ak sa niečo pokazí. Tento prístup zaručuje, že vývojári môžu rýchlo riešiť problémy, čím sa zabezpečí bezproblémové doručovanie obsahu. Predstavte si vytvorenie vizuálne ohromujúceho rozloženia príspevku pre klienta, len aby ste ho našli čiastočne zbavené v programe WordPress - tieto skripty zaisťujú, že sa to nikdy nestane! 🛠

// 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));

Pochopenie manipulácie s obsahom API WordPress REST API

API WordPress REST je výkonný nástroj, ktorý vývojárom umožňuje programovo vytvárať, čítať, aktualizovať a odstraňovať príspevky. Jedným z menej diskutovaných aspektov je však to, ako WordPress spracováva obsah pred jeho uložením do databázy. Pri použití rozhrania REST API aplikácia WordPress aplikuje sériu filtrov a dezantizačné kroky, aby sa zabezpečilo, že obsah je bezpečný a kompatibilný s jeho internými systémami. Aj keď je to vynikajúce pre zabezpečenie, môže to spôsobiť problémy vývojárom pracujúcimi s vlastnými HTML alebo blokmi od doplnkov, ako je Kadence. Napríklad komplexné rozloženia s vlastnými konfiguráciami metadát alebo blokov môžu byť čiastočne odstránené, pretože ich WordPress ich nesprávne interpretuje. 🛠

Ďalším kritickým faktorom je to, ako REST API interaguje dynamické bloky. Tieto bloky sa vykresľujú na frontendu pomocou PHP namiesto toho, aby boli uložené ako statické HTML. Ak váš vlastný blok nie je správne zaregistrovaný alebo API ho nerozpozná, niektoré z vašich konfigurácií blokov nemusia správne uložiť správne. Stáva sa to preto, že WordPress sa pokúša analyzovať a overiť blokové označenie počas procesu uloženia, ktorý môže neúmyselne odstrániť základné časti vášho obsahu. Aby sa tomu zabránilo, je dôležité použiť správnu registráciu blokov s atribútmi, ktoré zodpovedajú vášmu obsahu API.

Na vyriešenie týchto výziev vývojári často obížia štandardné filtre REST API vytvorením vlastných koncových bodov alebo prevažujúcim konkrétnym správaním WordPress. Napríklad použitie filtrov ako rest_pre_insert_post Umožňuje injekciu RAW HTML bez rušenia. Dôkladným prispôsobením týchto riešení môžete obísť predvolené spracovanie spoločnosti WordPress a zabezpečiť, aby vaše zložité rozloženie a návrhy zostali nedotknuté. Predstavte si, že vytvoríte ohromujúci banner s blokom Kadence, len aby ste videli, ako sa nesprávne vykreslil na frontendu - tieto riešenia to bránia tomu, aby sa to stalo! 🚀