Siirry sisältöön

Kokonaiset sivut määritetään koodissa

Mallipohjat ja Markdown synkronoidaan palveluun WordPress yhdellä komennolla.

Tiedostoista muodostettavat kokoelmat

Määritä pages.json, niin Blockstudio löytää kaikki sen alla olevat lähteet. Sisäkkäisistä poluista muodostuu sisäkkäisiä sivuja, oletusasetukset koskevat koko kokoelmaa ja puuttuvat yläsivut voidaan luoda.

Käytä kokoelmia dokumentaatioon, tietopankkeihin tai aloitussivuihin ja liitä ulkoisia kansioita polun etuliitteen alle määritteellä loader.php.

Lisää layout.php tai renderöijän asettelu, kuten layout.tsx, tiedoston pages.json viereen, jotta jokainen kokoelman sivu kääritään samaan rakenteeseen ja sivupalkkiin tulee blockstudio_page_tree().

pages/docs/pages.json
{
  "collection": "docs",
  "title": "Documentation",
  "postType": "bs_docs",
  "defaults": {
    "postStatus": "publish",
    "templateLock": "contentOnly"
  }
}

Nimenomainen synkronointi

wp bs pages sync ottaa muutokset käyttöön; muuttumattomille sivuille ei tehdä kirjoituksia.

Markdown-lähteet

Käytä index.md-tiedostoa etutietojen kanssa tai yhdistä page.json sisältöön Markdown.

Raaka Markdown

Markdown-tiedostosivut ovat saatavilla omassa polussaan URL sekä .md-päätteellä tai normaalissa URL-osoitteessa, kun Accept: text/markdown, ja niissä on kanoninen linkki takaisin kohteeseen HTML.

Kokoelmien lataajat

Liitä ulkoiset dokumentaatiokansiot kokoelmaan polun etuliitteen alle.

Sivustokokoelmat

pages.json, jonka laajuus on site, asettaa jaetut oletusarvot koko sivupuulle ja luettelee sen muuttamatta URL-osoitteita tai julkaisurivejä.

Navigoinnin apufunktiot

blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() ja blockstudio_page_content() rakentavat sivupalkit, sivutusnavigoinnin ja rungon.

Kokoelmat ja sisältötyypit

Kokoelmat voivat rekisteröidä omia hierarkkisia sisältötyyppejä.

Mallien lukitus

Lukitse sivuja tai yksittäisiä lohkoja asetuksilla contentOnly, all tai insert.

Kirjoita HTML, saat lohkot

Tavalliset elementit, kuten <h1>, <p> ja <ul>, vastaavat ydinlohkoja. Käytä <block>-määritystä muille lohkonimille ja sisäkkäisyystasoille.

Blockstudio jäsentää kokonaiset sivuasettelut oikeiksi, muokattaviksi WordPress-lohkoiksi.

index.php
<div>
  <h1 blockEditingMode="contentOnly">About Us</h1>
  <p>We build tools for WordPress developers.</p>
  <img src="/team.jpg" alt="Our team" />
</div>

<block name="core/columns">
  <block name="core/column"><h2>Our Mission</h2></block>
  <block name="core/column"><h2>Our Stack</h2></block>
</block>

Komponenteilla renderöidyt sivut

Aseta render kohdassa page.json esimerkiksi arvoon page.tsx ja määritä data.php-lataaja, niin teemasi tai lisäosasi rekisteröimä sivun renderöijä piirtää koko sivun. Synkronointi tallentaa yhden blockstudio/page-lohkon, ja WordPress-sisältö, kuten lyhytkoodi, pysyy omassa paikassaan.

Renderöijän palauttamia resursseja käsitellään samalla tavalla kuin lohkojen resursseja, ja ne tulostetaan kerran, joten esirenderöity sivu sisältää ne. blockstudio.dev itsessään koostuu komponenttisivuista.

pages/legal-notice/page.json
{
  "name": "legal-notice",
  "title": "Legal Notice",
  "slug": "legal-notice",
  "postStatus": "publish",
  "render": { "entry": "page.tsx", "data": "data.php" }
}

Reitit ilman julkaisua

Blockstudio\Virtual_Routes::register() palvelee asiakirjaa, jolla ei ole taustalla julkaisua, kuten komponenttiviitettä tai luetteloa. Kun käytössä ovat prefix ja match, yksi rekisteröinti vastaa kokonaisen URL-perheen pyyntöihin, ja palauttamalla null jätät URL-arvon WordPress-käsiteltäväksi.

Reitti renderöidään Blockstudio-arvon tulostuspuskuriin, joten sen lohkot saavat resurssinsa ja tulostuksensa muodossa Tailwind. Kohteen urls polut liitetään staattisiin esirenderöintikoontiversioihin, ja Virtual_Routes::urls() palauttaa ne sivustokarttaa varten.

functions.php
add_action( 'init', function () {
    Blockstudio\Virtual_Routes::register(
        'components',
        function ( $component, string $rest ) {
            get_header();
            echo my_component_page( $component );
            get_footer();
        },
        [
            'prefix' => true,
            'match'  => fn ( string $rest ) => '' === $rest ? 'index' : my_component( $rest ),
            'title'  => fn ( $component ) => my_component_title( $component ),
            'urls'   => fn () => my_component_paths(),
        ]
    );
} );

Synkronoi vain pyydettäessä

Sivutiedostot muuttavat WordPress-sisältöä vain pyynnöstäsi. wp bs pages sync ottaa käyttöön kaikki muuttuneet lähteet, säilyttää avainkentillä merkityn editorisisällön ja poistaa sivut, joiden tiedostoja ei enää ole.

Tarkisteet kattavat manifestit, lataajat, asettelut ja lähteet, joten muuttumattomille sivuille ei tehdä kirjoituksia. Julkaisut kutsuvat toimintoa Pages::reconcile() ja saavat koneellisesti luettavan raportin.

Pääte
# Apply changed sources, keep keyed edits
wp bs pages sync

# Replace managed content from the files
wp bs pages sync --authoritative

# Compare every page and report as JSON
wp bs pages sync --full --format=json

Avainkentillä merkityt lohkot säilyttävät sisällön

Lisää key mihin tahansa lohkoon. Seuraavassa synkronoinnissa avainkentillä merkityt lohkot yhdistävät mallipohjan ominaisuudet nykyiseen käyttäjäsisältöön, kun taas merkitsemättömät lohkot korvataan.

Muuta rakennetta julkaisujen välillä asiakkaiden sisällön säilyessä ennallaan.

index.php
<h1 key="title">About Us</h1>
<block name="core/cover" key="hero" url="/hero.jpg">
  <h2>Welcome to our company</h2>
  <p>Edit this content freely.</p>
</block>
<block name="core/columns" key="team">
  <block name="core/column"><h3>Our Team</h3></block>
</block>

Mallipohjien lukitseminen ja muokkaustilat

"all" estää muutokset, "contentOnly" lukitsee rakenteen mutta sallii tekstin muokkauksen ja "insert" sallii muokkauksen ja uudelleenjärjestelyn, mutta ei lisäämistä tai poistamista.

Ohita minkä tahansa elementin asetus määritteellä blockEditingMode, jotta voit sallia muokkauksen valikoidusti lukitulla sivulla tai poistaa yksittäisen lohkon käytöstä.

index.php
<h1>Welcome to Our Product</h1>
<p>The best solution for your needs.</p>
<block name="core/cover" blockEditingMode="disabled" url="/static-banner.jpg">
  <p>Promotional banner</p>
</block>
<block name="core/group" blockEditingMode="default">
  <h2>Customizable Section</h2>
</block>

Sivustoeditorin mallipohjat tiedostoista

Lisää template.json ja mallipohja kohteeseen templates/ tai lisää part.json kohteeseen parts/, niin lohkoteemasi saa tiedostoihin perustuvat wp_template– ja wp_template_part-lähteet.

Niissä käytetään samaa syntaksia kuin sivuissa. Sivustoeditorissa tehty mukautus pysyy käytössä, kunnes se nollataan. Sen jälkeen tiedostolähde palaa käyttöön.

templates/front-page/index.php
<block name="core/template-part" slug="header" />

<div>
  <h1>Welcome</h1>
  <block name="core/post-content" />
</div>

<block name="core/template-part" slug="footer" />

Valittu tietokantasisältö kohteessa git

wp bs content pull vie sallittujen julkaisujen, termien, suhteiden ja määritettyjen metatietojen tiedot siirrettäviin tiedostoihin, ja push soveltaa niitä toiseen ympäristöön. Määritetyt viittaukset, ylätason kohteet ja termisuhteet siirtyvät mukana pysyvinä UID-tunnisteina.

Sivusynkronoinnilla hallitut julkaisut voidaan yhdistää kohteeseen includePageSyncManaged. Niiden tiedostoissa on "bodyOwner": "page-sync", joten Content Sync siirtää metatiedot ja sivusynkronointi säilyttää rungon.

blockstudio.json
{
  "content": {
    "enabled": true,
    "id": "default",
    "path": "content",
    "postTypes": ["team_member"],
    "taxonomies": ["category"],
    "meta": {
      "include": ["_my_*"],
      "references": {
        "_thumbnail_id": { "kind": "attachment" },
        "_related_posts": { "kind": "post", "path": "*" }
      }
    },
    "media": "manifest"
  }
}

Avainlohko

Säilytä käyttäjien sisältö mallipohjien kehittyessä.

Muokkaustilat

Aseta sivujen oletusarvot ja ohita yksittäisten elementtien asetukset.

Lohkosidonnat

Yhdistä lohkot artikkelien metatietoihin, jotta sisältö säilyy synkronoinnissa.

Julkaisutyypin mallipohjat

templateFor määrittää sivun uuden julkaisutyypin julkaisun aloituslohkorakenteeksi.

Kiinnitetyt julkaisujen tunnisteet

postId palauttaa saman tunnisteen, kun sivu poistetaan ja synkronoidaan uudelleen, joten valikot ja linkit toimivat edelleen.

Pohjat ja lukitukset

sync: false yhdessä arvon Pages::force_sync() kanssa luo sivun kerran editorien omistettavaksi. Pages::lock() ja unlock() estävät yksittäisen sivun synkronoinnin.

Mukautetut jäsentimen renderöijät

Rakentajan ja renderöijän suodattimilla lohkotunniste voidaan muuntaa kolmannen osapuolen lohkon lohkomatriisiksi tai muuttaa sitä, miten ydinlohko kirjoitetaan.

Elementtien yhdistäminen

Yhdistä HTML-elementti toiseen lohkoon, valitse lohko elementin määritteiden perusteella ja ohjaa kappaleen HTML sisältökenttään.

Mukautetut etsintäpolut

Suodattimet lisäävät juuripolkuja sivuille, malleille ja sivustoeditorin mallipohjille, esimerkiksi lisäosasta.

Loogiset etsintälähteet

Esikatselut, peittokuvat ja luodut teemat voivat antaa Blockstudio-arvolle kootun tiedostoluettelon yksittäisen teemakansion sijaan.

Pysyvät viittaukset

Ilmoitetuista julkaisu-, termi- ja liiteviittauksista tulee siirrettäviä UID-tunnisteita tietoja noudettaessa, ja ne ratkaistaan paikallisiksi tunnisteiksi tietoja lähetettäessä.

Tila ennen lähetystä

wp bs content status raportoi kunkin entiteetin tilaksi muuttumaton, päivitettävä, puuttuu tietokannasta, ristiriidassa, lukittu tai orpo sekä varoittaa salaisuuksilta näyttävistä metatietojen avaimista.

Vahvistetut, rajatut lähetykset

Lähetys vahvistaa koko suunnitelman ennen kirjoittamista ja ohittaa lukitut entiteetit. –dry-run näyttää suunnitelman, ja –prune –yes poistaa vain tämän sisältöjoukon entiteetit.

Versionhallittu

Seuraa sivutiedostoja kohteessa Git ja julkaise ne eri ympäristöihin.

PHP API

Käytä ohjelmallisesti puuhakemistoja, alisivuja, metatietoja, synkronointia, lukitusta ja tunnisteita.

Plus

Virallinen laajennuspaketti

Premium-sivupohjia, tekoälyn järjestelmäohjeita ja yksityinen Discord-yhteisö. Kertamaksu, elinikäiset päivitykset.

  • 500+ sivustomallia
  • Tekoälyn järjestelmäohjeet
  • Elinikäiset päivitykset
  • Yksityinen Discord-yhteisö