Przejdź do treści

Pełne strony zdefiniowane w kodzie

Szablony i Markdown, synchronizowane z WordPress jednym poleceniem.

Kolekcje z plików

Zdefiniuj pages.json, a Blockstudio wykryje wszystkie znajdujące się w nim źródła. Zagnieżdżone ścieżki staną się zagnieżdżonymi stronami, ustawienia domyślne obejmą kolekcję, a brakujące strony nadrzędne mogą zostać wygenerowane.

Używaj kolekcji do dokumentacji, baz wiedzy lub stron docelowych, a zewnętrzne foldery dołączaj pod prefiksem ścieżki za pomocą loader.php.

Umieść layout.php lub układ renderera, taki jak layout.tsx, obok pages.json, aby opakować każdą stronę kolekcji w jeden szablon, z blockstudio_page_tree() na panel boczny.

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

Jawna synchronizacja

Polecenie wp bs pages sync stosuje zmiany; niezmienione strony nie wymagają żadnego zapisu.

Źródła Markdown

Użyj index.md z metadanymi frontmatter albo połącz page.json z treścią Markdown.

Surowe Markdown

Strony plikowe Markdown są dostępne pod adresem URL plus .md lub pod zwykłym URL dla Accept: text/markdown, z linkiem kanonicznym prowadzącym z powrotem do HTML.

Moduły ładujące kolekcji

Dołącz zewnętrzne foldery dokumentacji do kolekcji pod prefiksem ścieżki.

Kolekcje witryny

pages.json z zakresem site stosuje wspólne wartości domyślne do całego drzewa stron i wyświetla jego listę, nie zmieniając adresów URL ani wierszy wpisów.

Pomocniki nawigacji

blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() i blockstudio_page_content() tworzą panele boczne, paginację i treść.

Kolekcje i typy wpisów

Kolekcje mogą rejestrować dedykowane hierarchiczne typy wpisów.

Blokowanie szablonu

Blokuj strony lub pojedyncze bloki za pomocą contentOnly, all lub insert.

Pisz HTML, otrzymuj bloki

Standardowe elementy, takie jak <h1>, <p> i <ul>, są mapowane na bloki podstawowe. Użyj <block> dla każdej innej nazwy bloku i poziomu zagnieżdżenia.

Blockstudio analizuje kompletne układy stron i zamienia je w prawdziwe, edytowalne bloki WordPress.

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>

Strony renderowane przez komponenty

Ustaw render w page.json na wpis, taki jak page.tsx, oraz loader data.php, a renderer strony zarejestrowany przez Twój motyw lub wtyczkę wyrenderuje całą stronę. Synchronizacja przechowuje jeden blok blockstudio/page, a treść WordPress, taka jak shortcode, pozostaje w swoim miejscu.

Zasoby zwracane przez renderer są przetwarzane tak samo jak zasoby bloków i drukowane tylko raz, dzięki czemu wstępnie wyrenderowana strona je zawiera. Samo blockstudio.dev jest zbudowane ze stron komponentów.

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

Trasy bez wpisu

Blockstudio\Virtual_Routes::register() udostępnia dokument, za którym nie ma wpisu, taki jak dokumentacja komponentu lub katalog. W połączeniu z prefix i match jedna rejestracja obsługuje całą rodzinę adresów URL, a zwrócenie null pozostawia URL do WordPress.

Trasa jest renderowana w buforze wyjściowym Blockstudio, więc jej bloki otrzymują zasoby i wyjście Tailwind. Ścieżki w urls są uwzględniane w kompilacjach statycznego prerenderowania, a Virtual_Routes::urls() je zwraca na potrzeby mapy witryny.

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(),
        ]
    );
} );

Synchronizacja na Twoje żądanie

Pliki stron zmieniają WordPress tylko na Twoje żądanie. wp bs pages sync stosuje każdą zmienioną wersję źródłową, zachowuje treść z edytora przypisaną do kluczy i usuwa strony, których pliki zniknęły.

Odciski obejmują manifesty, moduły ładujące, układy i źródła, więc niezmienione strony nie wymagają żadnego zapisu. Wdrożenia wywołują Pages::reconcile() i otrzymują raport czytelny dla maszyn.

Terminal
# 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

Bloki z kluczami zachowują treść

Dodaj key do dowolnego bloku. Przy następnej synchronizacji bloki z kluczami łączą atrybuty szablonu z istniejącą treścią użytkownika, a bloki bez kluczy są zastępowane.

Rozwijaj strukturę między wdrożeniami, zachowując treść klientów.

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>

Blokowanie szablonów i tryby edycji

"all" blokuje zmiany, "contentOnly" blokuje strukturę, pozwalając edytować tekst, a "insert" pozwala edytować i zmieniać kolejność bez dodawania ani usuwania elementów.

Nadpisz dowolny element za pomocą blockEditingMode, aby umożliwić wybiórczą edycję zablokowanej strony lub wyłączyć pojedynczy blok.

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>

Szablony edytora witryny z plików

Dodaj template.json i szablon do templates/ albo part.json do parts/, a motyw blokowy otrzyma źródła wp_template i wp_template_part oparte na plikach.

Używają tej samej składni co strony. Dostosowanie w Edytorze witryny nadal ma pierwszeństwo, dopóki ktoś go nie zresetuje; wtedy wraca źródło plikowe.

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" />

Wybrana zawartość bazy danych w git

wp bs content pull eksportuje wpisy, terminy, relacje i zadeklarowane metadane z listy dozwolonych do przenośnych plików, a push stosuje je w innym środowisku. Zadeklarowane referencje, elementy nadrzędne i relacje terminów są przenoszone jako stabilne UID.

Wpisy zarządzane przez synchronizację stron mogą być powiązane z includePageSyncManaged. Ich pliki zawierają "bodyOwner": "page-sync", dzięki czemu Content Sync przenosi metadane, a synchronizacja stron zachowuje treść.

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"
  }
}

Bloki z kluczami

Zachowuj treść użytkownika podczas zmian szablonów.

Tryby edycji

Ustaw domyślne opcje strony i nadpisuj je dla poszczególnych elementów.

Powiązania bloków

Połącz bloki z metadanymi wpisu, aby treść przetrwała synchronizację.

Szablony typów wpisów

templateFor ustawia stronę jako początkową strukturę bloków każdego nowego wpisu danego typu.

Przypięte identyfikatory wpisów

postId przywraca to samo ID, gdy strona zostanie usunięta i ponownie zsynchronizowana, dzięki czemu menu i linki nadal działają.

Szkielety i blokady

sync: false w połączeniu z Pages::force_sync() tworzy stronę raz, aby redaktorzy mogli nią zarządzać. Pages::lock() i unlock() wykluczają pojedynczą stronę z synchronizacji.

Niestandardowe renderery parsera

Filtry buildera i renderera zamieniają tag bloku na tablicę bloków bloku innej firmy lub zmieniają sposób zapisu bloku podstawowego.

Mapowanie elementów

Mapuj element HTML na inny blok, wybieraj blok na podstawie atrybutów elementu i kieruj akapity HTML do pola treści.

Niestandardowe ścieżki wyszukiwania

Filtry dodają katalogi główne stron, wzorców i szablonów Edytora witryny, na przykład z wtyczki.

Logiczne źródła wyszukiwania

Podglądy, nakładki i wygenerowane motywy mogą przekazać Blockstudio złożony spis plików zamiast jednego folderu motywu.

Stabilne odwołania

Zadeklarowane odwołania do wpisów, terminów i załączników stają się przenośnymi UID podczas pobierania i są rozwiązywane do lokalnych ID podczas wysyłania.

Stan przed wysłaniem

wp bs content status zgłasza każdy element jako niezmieniony, wymaga aktualizacji, brakujący w bazie danych, w konflikcie, zablokowany lub osierocony, a także ostrzega o kluczach meta przypominających sekrety.

Zweryfikowane wysyłanie z określonym zakresem

Przed zapisem push weryfikuje cały plan i pomija zablokowane elementy. –dry-run wyświetla plan, a –prune –yes usuwa wyłącznie elementy z tego zestawu treści.

Pod kontrolą wersji

Śledź pliki stron w Git i wdrażaj je w różnych środowiskach.

PHP API

Programowo uzyskuj dostęp do drzew, elementów podrzędnych, metadanych, synchronizacji, blokad i identyfikatorów.

Plus

Oficjalny zestaw rozszerzeń

Wysokiej jakości szablony witryn, systemowe instrukcje AI i prywatna społeczność Discord. Jednorazowy zakup, dożywotnie aktualizacje.

  • 500+ szablonów stron
  • Instrukcje systemowe AI
  • Dożywotnie aktualizacje
  • Prywatna społeczność Discord