Przejdź do treści

CLI

Blockstudio rejestruje polecenia WP-CLI do zarządzania blokami, stronami przechowywanymi w plikach, rekordami bazy danych, funkcjami RPC, zadaniami cron, ustawieniami i konfiguracją języka WPML z poziomu terminala.

Bloki

Wyświetl wszystkie bloki

Powłoka
wp bs blocks list
Kod
+----------------------------+---------------------+-----------+------------------------+
| name                       | title               | component | category               |
+----------------------------+---------------------+-----------+------------------------+
| my-theme/hero              | Hero                |           | my-theme               |
| my-theme/card              | Card                | yes       | my-theme               |
| my-theme/newsletter        | Newsletter          |           | my-theme               |
+----------------------------+---------------------+-----------+------------------------+

Ogranicz wyniki do samych komponentów

Powłoka
wp bs blocks list --components

Wyświetl jako JSON

Powłoka
wp bs blocks list --format=json

Weryfikacja zapisanych pól

Powłoka
wp bs blocks validate 42
wp bs blocks validate 42 57 --format=json

Sprawdza zapisaną treść wskazanych identyfikatorów wpisów, w tym zagnieżdżone innerBlocks, za pomocą bs_validate_block(). Nie renderuje bloków, nie rozwija odwołań do zsynchronizowanych wzorców ani nie modyfikuje wpisów. Nieznane bloki bez rozszerzeń Blockstudio są pomijane.

Domyślna tabela zawiera identyfikator wpisu, indeksowaną od zera ścieżkę bloku, nazwę bloku, kod wykrycia, ścieżkę pola, źródło i komunikat. JSON zawiera również oryginalne wartości value i expected. Ścieżką zagnieżdżonego bloku może być 0/1, a ścieżką pola cards/2/style; są to osobne ścieżki.

Polecenie kończy działanie z kodem 0, gdy nie ma wykrytych problemów, i 1, gdy problemy występują. Wynik JSON to zwykła lista, zawierająca [] także przy powodzeniu, dzięki czemu automatyzacja może ją odczytać nawet wtedy, gdy polecenie kończy działanie z kodem 1. Brakujące wpisy, brakujące identyfikatory oraz formaty inne niż table lub json są błędami. Wszystkie identyfikatory są sprawdzane przed rozpoczęciem weryfikacji.

Renderowanie bloków

Powłoka
wp bs blocks render
wp bs blocks render my-theme/hero my-theme/card
wp bs blocks render my-theme/card --attributes='{"variant":"wide"}'
wp bs blocks render my-theme/card --attributes=@card.json --format=json

Renderuje zarejestrowane bloki tak jak strona i zgłasza każde powiadomienie PHP, ostrzeżenie, komunikat o przestarzałym elemencie oraz zgłoszony błąd wygenerowany przez ich szablony. Motyw może uruchamiać to polecenie w CI, aby przeprowadzić wstępny test swoich bloków względem zainstalowanego Blockstudio. Jeśli nie podano nazw, renderowany jest każdy zarejestrowany blok, w tym komponenty.

Każdy blok jest renderowany przez do_blocks() na podstawie komentarza bloku z blockstudio.attributes, czyli strukturą zapisywaną przez edytor, w kontekście frontendu WP-CLI, a nie podglądu wstawiacza. Żaden odpytywany wpis nie jest przygotowywany do renderowania. Dynamiczne wyspy renderują rzeczywistą treść szablonu zamiast samego elementu zastępczego, a przypadkowe wyniki szablonu nie trafiają do raportu.

Samo polecenie nie zapisuje wpisów ani wartości pól, ale wykonuje szablony i funkcje renderujące tak jak zwykłe PHP. Mogą one zapisywać dane, wywoływać usługi zewnętrzne lub powodować inne skutki uboczne. Uruchamiaj je na zaufanym kodzie w dedykowanej witrynie testowej; nie jest to piaskownica tylko do odczytu.

Atrybuty renderowania są wybierane osobno dla każdego bloku:

Przypadek Atrybuty
example example.attributes bloku block.json, czyli wartości używane przez podgląd wstawiacza.
defaults default każdego pola. Używane dla bloków bez example.attributes; polecenie wypisuje osobny wiersz dla każdego pola.
attributes Wartości --attributes zastępujące przykład.

--attributes przyjmuje obiekt JSON z wartościami pól przypisanymi do kluczy przechowywania albo @ oraz ścieżkę pliku, który taki obiekt zawiera; wymaga podania dokładnie jednej nazwy bloku. Użyj go, aby uzyskać dostęp do gałęzi szablonu, których nie obejmuje przykład, takich jak wariant. Przykładowe wartości, które w podglądzie wstawiacza generują wyłącznie obrazy zastępcze, są pomijane, a innerBlocks przykładu nie są renderowane.

Kod
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| block               | case     | level      | message                                                                       | file                                                                         | line |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| smoke/deprecated    | defaults | Deprecated | strlen(): Passing null to parameter #1 ($string) of type string is deprecated | /wordpress/wp-content/themes/smoke-theme/blockstudio/deprecated/index.php    | 1    |
| smoke/undefined-key | example  | Warning    | Undefined array key "subtitle"                                                | /wordpress/wp-content/themes/smoke-theme/blockstudio/undefined-key/index.php | 2    |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+

Tabela zawiera jeden wiersz na każdy problem. Wynik JSON to lista z jednym wpisem dla każdego renderowanego bloku, także tych bez problemów, dzięki czemu automatyzacja może odczytać użyty przypadek:

JSON
[
  {
    "block": "smoke/branch",
    "case": "attributes",
    "problems": [
      {
        "level": "Warning",
        "message": "Undefined array key \"width\"",
        "file": "/wordpress/wp-content/themes/smoke-theme/blockstudio/branch/index.php",
        "line": 2
      }
    ]
  }
]

level to Notice, Warning, Deprecated lub Error. Problem powtarzający się w tym samym pliku i wierszu, na przykład w pętli, jest zgłaszany raz dla każdego bloku. Problemy wyciszone za pomocą @ nie są zgłaszane. WordPress zgłasza własne powiadomienia o przestarzałych elementach, takie jak te dotyczące _deprecated_function(), tylko wtedy, gdy włączono WP_DEBUG.

Polecenie kończy działanie z kodem 0, jeśli nie znaleziono problemów, i 1 w przeciwnym razie. Nieznane nazwy bloków, nieczytelny lub nieprawidłowy plik --attributes oraz formaty inne niż table lub json są błędami; wszystkie nazwy są sprawdzane przed renderowaniem pierwszego bloku.

Strony

Synchronizacja stron przechowywanych w plikach odbywa się jawnie. Zwykłe żądania WordPress nigdy nie wykrywają wszystkich stron ani nie zapisują wpisów stron. Zimne środowisko uruchomieniowe może jednorazowo odczytać manifesty kolekcji, aby odtworzyć trasy, bez synchronizowania treści.

Powłoka
wp bs pages sync

Polecenie uzgadnia cały docelowy wykaz i raportuje strony wykryte, utworzone, zaktualizowane, niezmienione, zablokowane, zachowane i usunięte, a także te, których przetwarzanie się nie powiodło. Zgodność odcisków palca oznacza brak zapisów wpisu i metadanych wpisu.

Wynik tabelaryczny wymienia zmienione, zablokowane, zachowane pod względem treści i usunięte strony wraz z ich identyfikatorami wpisów. JSON zawiera wpisy pages.<name>.preserved, pages.<name>.overwritten i removedPages z nazwą strony, kluczem, identyfikatorem wpisu i działaniem porządkującym. Wpis identyczny po scaleniu według kluczy jest oznaczany jako niezmieniony, bez tworzenia rewizji ani aktualizowania znacznika czasu modyfikacji.

Istniejące statusy publikacji są zachowywane; zamiany tytułu i uproszczonego adresu URL zarządzane przez plik są wypisywane jako ostrzeżenia. Zobacz Własność pól wpisu.

Użyj --authoritative, aby zastąpić zarządzaną treść zamiast zachowywać treść edytora przypisaną do kluczy, a --full, aby raportować przebieg jako pełne uzgodnienie niezależnie od zapisanej tożsamości źródła. W obu przypadkach każdy przebieg porównuje pełny spis:

Powłoka
wp bs pages sync --authoritative --full

W przypadku skryptów wdrożeniowych, które wymagają pełnego raportu:

Powłoka
wp bs pages sync --format=json

Każda strona analizowana przez polecenie jest sprawdzana pod kątem atrybutów przechowywanych przez jej bloki, ale nigdy przez nie renderowanych: atrybutów, których blok Blockstudio ani nie deklaruje jako pola, ani nie przekazuje do elementu głównego, takich jak niezadeklarowane class. W tabeli wyświetlane jest ostrzeżenie dla każdej strony i bloku, kolumna dropped zlicza te atrybuty, a raport JSON wymienia je w sekcji pages.<name>.droppedAttributes. Strony, których źródło się nie zmieniło, nie są ponownie analizowane, dlatego zostaną zgłoszone przy następnej zmianie lub podczas pierwszej synchronizacji po aktualizacji zmieniającej parser.

Polecenie kończy się błędem, gdy wykrywanie lub uzgadnianie zgłosi błąd. Zobacz Strony, aby poznać umowę dotyczącą PHP API i tożsamości wdrożenia.

Baza danych

Wyświetl schematy

Powłoka
wp bs db schemas
Kod
+-------------------+-------------+---------+---------------------+
| block             | schema      | storage | fields              |
+-------------------+-------------+---------+---------------------+
| my-theme/app      | subscribers | table   | email, name, plan   |
| my-theme/app      | logs        | jsonc   | action, details     |
| my-theme/app      | events      | storh   | title, status       |
+-------------------+-------------+---------+---------------------+

Operacje CRUD

Powłoka
# List records
wp bs db list my-theme/app subscribers

# List with filters
wp bs db list my-theme/app subscribers --plan=pro --limit=10

# Get a single record
wp bs db get my-theme/app subscribers 1

# Create a record
wp bs db create my-theme/app subscribers --email=a@b.com --plan=pro

# Update a record
wp bs db update my-theme/app subscribers 1 --plan=enterprise

# Delete a record
wp bs db delete my-theme/app subscribers 1

W przypadku bloków z jednym schematem domyślną nazwą schematu jest default:

Powłoka
wp bs db list my-theme/leads

Migruj rekordy JSONC do Storh

Użyj migrate, gdy schemat ma już plik db/{schema}.jsonc i chcesz przenieść te rekordy do zaplecza plikowego Storh:

Powłoka
wp bs db migrate my-theme/app subscribers --to=storh

W przypadku bloków z jednym schematem:

Powłoka
wp bs db migrate my-theme/app --to=storh

Polecenie zachowuje identyfikatory rekordów typu integer, zapisuje do uploads/blockstudio/db/{block-scope}/{schema}/, odbudowuje indeksy Storh, weryfikuje docelowy magazyn i pozostawia źródłowy plik .jsonc na miejscu.

Formaty wyjściowe

Wszystkie polecenia listowania obsługują formaty --format=table (domyślny), --format=json i --format=csv:

Powłoka
wp bs db list my-theme/app subscribers --format=json

RPC

Wyświetl wszystkie funkcje

Powłoka
wp bs rpc list
Kod
+-------------------+-------------+--------+----------------+---------+
| block             | function    | public | capability     | methods |
+-------------------+-------------+--------+----------------+---------+
| my-theme/app      | subscribe   | yes    |                | POST    |
| my-theme/app      | stats       |        | edit_posts     | POST    |
| my-theme/app      | get_status  |        |                | GET,POST|
+-------------------+-------------+--------+----------------+---------+

Wywołaj funkcję

Powłoka
wp bs rpc call my-theme/app subscribe --email=user@example.com

Dane wyjściowe są w formacie JSON:

JSON
{
  "success": true
}

Parametry są przekazywane jako flagi --key=value:

Powłoka
wp bs rpc call my-theme/app load_more --offset=10 --limit=5

Cron

Wyświetl wszystkie zadania

Powłoka
wp bs cron list
Kod
+-------------------+----------+----------+---------------------+
| block             | job      | schedule | next_run            |
+-------------------+----------+----------+---------------------+
| my-theme/app      | cleanup  | daily    | 2026-03-17 00:00:00 |
| my-theme/app      | sync     | hourly   | 2026-03-16 15:00:00 |
+-------------------+----------+----------+---------------------+

Uruchom zadanie ręcznie

Powłoka
wp bs cron run my-theme/app cleanup

To natychmiast wykonuje funkcję zwrotną, niezależnie od harmonogramu. Przydatne do testowania i debugowania.

Ustawienia

Pokaż wszystkie ustawienia

Powłoka
wp bs settings list

Pobierz określone ustawienie

Powłoka
wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue

Tailwind

Skompiluj HTML do CSS

Powłoka
wp bs tailwind compile '<div class="flex items-center p-4">'

Skompiluj z pliku

Powłoka
wp bs tailwind compile --file=template.html

Zarządzanie pamięcią podręczną

Powłoka
wp bs tailwind cache path    # show cache directory
wp bs tailwind cache clear   # clear compiled cache

SCSS

Skompiluj SCSS do CSS

Powłoka
wp bs scss compile '$color: red; .test { color: $color; }'

Skompiluj z pliku

Powłoka
wp bs scss compile --file=styles.scss

Pola niestandardowe

Wyświetl wszystkie zarejestrowane pola niestandardowe

Powłoka
wp bs fields list
Kod
+-------+----------------+---------------------------+
| name  | title          | fields                    |
+-------+----------------+---------------------------+
| hero  | Hero Section   | heading, description, cta |
| card  | Card           | title, image, link        |
+-------+----------------+---------------------------+

Zasoby

Wyświetl wszystkie zasoby

Powłoka
wp bs assets list

Filtruj według typu

Powłoka
wp bs assets list --type=global
wp bs assets list --type=admin
wp bs assets list --type=editor
wp bs assets list --type=registered

Skrypty

Wszystkie polecenia obsługują --format=json, co ułatwia przekazywanie danych potokiem:

Powłoka
# Export all subscribers as JSON
wp bs db list my-theme/app subscribers --format=json > subscribers.json

# Count records
wp bs db list my-theme/app subscribers --format=json | jq length

# Batch delete
wp bs db list my-theme/app logs --format=json | \
  jq -r '.[].id' | \
  xargs -I {} wp bs db delete my-theme/app logs {}

Synchronizacja treści

Projekty Content Sync synchronizują dozwolone treści WordPress z plikami i stosują te pliki z powrotem w bazie danych. Synchronizacja jest jawna i sterowana przez CLI; nie odbywa się przy ładowaniu strony ani podczas inicjalizacji panelu administracyjnego.

Zobacz Synchronizacja treści, aby poznać konfigurację, format plików i wskazówki dotyczące sytuacji, w których treści bazy danych oparte na plikach są dobrym rozwiązaniem.

Pobierz treść z bazy danych do plików

Powłoka
wp bs content pull

Ogranicz pobieranie do jednego skonfigurowanego typu wpisu lub taksonomii:

Powłoka
wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category

Wyświetl podgląd bez zapisywania UID-ów ani plików:

Powłoka
wp bs content pull --dry-run

Wyślij pliki do bazy danych

Powłoka
wp bs content push

Wyświetl podgląd planu zastosowania bez zapisywania zmian:

Powłoka
wp bs content push --dry-run

Usuń wpisy i terminy bazy danych należące do zestawu treści, które nie mają już odpowiedników w plikach:

Powłoka
wp bs content push --prune --yes

Z opcją --prune, Blockstudio najpierw stosuje wszystkie zmiany w plikach, a następnie usuwa encje należące do zestawu treści, które nie mają już odpowiedników w plikach. Odmówi wykonania destrukcyjnego usuwania, jeśli nie podano --yes.

Sprawdź stan

Powłoka
wp bs content status

Tabela oznacza każdą encję opartą na pliku jako unchanged, would-update, missing-db, conflict, locked lub orphaned.

Wstępne generowanie statyczne

Informacje o samej pamięci podręcznej znajdziesz w sekcji Wstępne generowanie statyczne; te polecenia nią sterują.

Odśwież nieaktualne wpisy

Powłoka
wp bs prerender warm

Dodaje do kolejki nieaktualne publiczne adresy URL, a następnie ponownie renderuje maksymalnie warm.concurrency zadań z trwałej kolejki odświeżania i wyświetla podsumowanie JSON z licznikami queued, processed, warmed, skipped i failed. Zmiany treści i witryny automatycznie dodają zadania zastępcze. Uruchom polecenie ponownie lub poczekaj na zaplanowane odświeżanie, aby przetworzyć większą kolejkę; element URL, którego renderowanie się nie powiedzie, pozostaje nieaktualny i zostaje ponownie dodany do kolejki przy następnym uruchomieniu. W trybie graph odświeżanie dla każdego URL jest wyłączone, a polecenie niczego nie dodaje do kolejki.

Raportuj stan pamięci podręcznej

Powłoka
wp bs prerender status

Raportuje aktywną tożsamość, pliki, bajty, rekordy grafu, stan kolejki, raport mapy wczesnego serwowania oraz liczniki trafień, chybień, budowania i błędów dla każdego zakresu.

Wyczyść pamięć podręczną

Powłoka
wp bs prerender purge

Usuwa wstępnie wygenerowane dokumenty bieżącej witryny. Odbudowuje je następne anonimowe żądanie lub przebieg odświeżania.

Sprawdź i oczyść mapę wczesnego serwowania

Powłoka
wp bs prerender map status
wp bs prerender map prune --dry-run
wp bs prerender map prune

map status raportuje mapę wczesnego serwowania dla całej instalacji: jej wpisy i trasy, brakujące dokumenty tras, wpisy orphaned dotyczące witryn, które już nie istnieją, oraz wpisy dead dotyczące nieistniejących katalogów. map prune usuwa osierocone i nieaktywne wpisy, podając powód usunięcia każdego z nich; --dry-run wyświetla ten sam raport bez zapisywania zmian. Mapa należąca do innego narzędzia nigdy nie jest modyfikowana.

WPML

Generowanie konfiguracji języka

Powłoka
wp bs wpml config
wp bs wpml config --file=wp-content/themes/my-theme/wpml-config.xml

Wyświetla plik wpml-config.xml deklarujący pola tekstowe wszystkich zarejestrowanych bloków do tłumaczenia oraz pola plików jako identyfikatory załączników albo zapisuje go za pomocą --file. W istniejącym pliku zastępowana jest tylko sekcja między znacznikami Blockstudio. Zobacz WPML, aby dowiedzieć się, co jest deklarowane i jak aktualizować plik.

Migracja tagów bloków

Samodzielny skrypt przepisuje skrócone formy prefiksów i aliasów na kanoniczny zapis <bs:namespace-slug>. Nie ładuje WordPress ani niczego nie zapisuje, chyba że jawnie podano --apply:

Powłoka
php vendor/blockstudio/blockstudio/bin/migrate-block-tags.php \
  --root="$PWD" \
  --prefix-map=/tmp/project-prefixes.json \
  --known-blocks=/tmp/project-blocks.json \
  --aliases=/tmp/project-aliases.json \
  --report=/tmp/blockstudio-tag-migration.json \
  --dry-run

Plik prefiksów mapuje prefiksy należące do wywołującego na uporządkowane przestrzenie nazw. Plik znanych bloków to lista JSON zarejestrowanych nazw bloków. Dokładne aliasy są opcjonalne. Raport zawiera deterministyczne mapowania, skróty przed i po zmianie, nieznane tagi, niejednoznaczne aliasy, tagi dynamiczne oraz przykłady znalezione w komentarzach, blokach kodu, zakresach <pre> lub <code>.

Skaner obsługuje znaczniki sparowane, zagnieżdżone i samozamykające, w tym dosłowne tagi w ciągach PHP. Zachowuje atrybuty i zmienia wyłącznie nazwy tagów. Komentarze i przykłady kodu są tylko raportowane. Niezwiązane elementy niestandardowe są ignorowane. Zastosowanie migracji jest blokowane, gdy pozostają nieznane, niejednoznaczne lub dynamiczne przypadki, chyba że wywołujący celowo przekaże --allow-unresolved. Ponowne uruchomienie polecenia na kanonicznym wyniku nie wprowadza zmian.

Zobacz Migracja, aby dowiedzieć się, skąd wziął się kanoniczny zapis i jakie problemy rozwiązuje.

Usuwanie

Powłoka
wp bs teardown

Usuwa zdarzenia cron i stan wstępnego generowania statycznego należące do instalacji: wpis mapy wczesnego serwowania bieżącej witryny oraz współdzielone rozszerzenie advanced-cache.php i deklarację WP_CACHE, gdy zniknie ostatni należący do instalacji wpis. Instalacje bez punktu zaczepienia dezaktywacji wtyczki, takie jak konfiguracje Composer, używają tego mechanizmu do czystego usunięcia. Pliki konfiguracyjne pozostają nietknięte.