Začíname
Tento sprievodca vám pomôže nastaviť Blockstudio a vytvoriť váš prvý vlastný blok.
Inštalácia
Cez Composer (odporúčané)
composer require blockstudio/blockstudio
Blockstudio možno nainštalovať ako plugin prostredníctvom composer/installers alebo ho priamo zahrnúť do témy. Všetky spôsoby inštalácie nájdete v dokumentácii Composer.
Inštalácie Composer dostávajú aktualizácie prostredníctvom Composer. Vstavaný aktualizátor GitHub sa automaticky deaktivuje.
Manuálna inštalácia
Stiahnite si najnovšie vydanie z GitHub
Nahrajte súbor zip do priečinka doplnkov WordPress a aktivujte doplnok. Manuálne inštalácie dostávajú automatické upozornenia na aktualizácie na nástenke WordPress prostredníctvom vstavaného aktualizátora GitHub.
Oba spôsoby inštalácie obsahujú súkromné kópie knižníc Markdown, YAML a na aktualizáciu spolu s ich závislosťami. Nepoužívajú ani nenahrádzajú verzie poskytované iným pluginom alebo témou. Ak vaša aplikácia používa niektorú z týchto knižníc priamo, nainštalujte si vlastnú závislosť Composer; pribalené kópie v Blockstudio sú interné, nie verejné PHP API.
Kontroly aktualizácií s overením
Manuálne inštalácie štandardne kontrolujú GitHub anonymne. Niekoľko stránok zdieľajúcich jednu odchádzajúcu IP môže vyčerpať anonymný limit API pre GitHub a pri kontrole aktualizácií dostávať odpovede HTTP 403. V 7.7.4 nakonfigurujte osobný prístupový token GitHub v wp-config.php ešte pred načítaním WordPress:
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');
Token potrebuje prístup iba k verejným informáciám o repozitári. Neudeľujte mu oprávnenia na zápis. Uchovávajte ho v konfigurácii na strane servera, mimo správy verzií a mimo blockstudio.json, atribútov blokov a kódu na strane klienta. Aktualizátor ho odovzdáva pribalenému klientovi GitHub na overovanie a sťahovanie vydaní. Požiadavky na nesúvisiace repozitáre a iné servery na sťahovanie token nedostávajú.
Ak spravujete tajomstvá prostredníctvom prostredia, token môže poskytnúť alebo prepísať MU plugin:
<?php
add_filter('blockstudio/updater/token', function ($token) {
return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});
Filter sa spustí pri inicializácii aktualizátora Blockstudio, ešte pred načítaním témy. Zaregistrujte ho v MU plugine, nie v functions.php. Vrátením prázdneho reťazca sa overovanie vypne, aj keď je konštanta definovaná. Prázdne hodnoty alebo hodnoty, ktoré nie sú reťazcom, ponechajú kontroly anonymné. Tokeny sú voliteľné; bez tokenu zostáva doterajšie správanie pri aktualizáciách nezmenené. Inštalácie Composer naďalej používajú na aktualizácie Composer a tento aktualizátor neinicializujú.
Vytvorenie prvého bloku
1. Vytvorte priečinok bloku
Vytvorte nový priečinok vo svojej téme:
my-theme/
blockstudio/
my-first-block/
block.json
index.php
2. Definujte schému bloku
Vytvorte block.json s konfiguráciou bloku:
{
"$schema": "https://blockstudio.dev/schema/block",
"name": "my-theme/my-first-block",
"title": "My First Block",
"category": "common",
"icon": "star-filled",
"blockstudio": {
"attributes": [
{
"id": "heading",
"type": "text",
"label": "Heading",
"default": "Hello World"
},
{
"id": "content",
"type": "textarea",
"label": "Content"
}
]
}
}
3. Vytvorte šablónu
Vytvorte index.php na vykresľovanie:
<div class="my-first-block">
<h2><?php echo $a['heading']; ?></h2>
<p><?php echo $a['content']; ?></p>
</div>
Používanie šablón Twig
Blockstudio podporuje šablóny Twig ihneď po inštalácii. Stačí namiesto toho použiť index.twig:
<div class="my-first-block">
<h2>{{ a.heading }}</h2>
<p>{{ a.content }}</p>
</div>
Pridanie štýlov
Vytvorte súbor style.css v rovnakom priečinku:
.my-first-block {
padding: 2rem;
background: #f5f5f5;
}
Blockstudio automaticky zaradí tento štýl do frontu pri použití bloku.
Preklady
Ovládacie prvky editora a administračný prehľad Blockstudio načítavajú preklady JavaScript textovej domény blockstudio prostredníctvom WordPress. Nainštalujte príslušný jazykový balík alebo pomocou prekladateľského nástroja vygenerujte súbory prekladu skriptov JSON v wp-content/languages/plugins/. Reťazce bez dostupného prekladu zostávajú v angličtine. Prekladá sa tým vlastné rozhranie Blockstudio, nie obsah ani štítky polí, ktoré definujete vo svojich blokoch.
Ďalšie kroky
Váš blok je teraz pripravený na použitie v editore WordPress. Pokračujte v prezeraní dokumentácie a zistite viac o týchto témach:
- Typy polí – Všetky dostupné typy polí
- Komponenty – InnerBlocks, RichText a ďalšie
- TailwindIntegrácia – Používanie Tailwind CSS
- Hooky – Rozšírenie funkcií pomocou filtrov a akcií
Prejdite od jediného bloku k celej knižnici: návrhové tokeny, vzor sekcie, opakovače, obrázky a skladanie stránok.