Alustamine
See juhend aitab teil seadistada Blockstudio ja luua oma esimese kohandatud ploki.
Paigaldamine
Composer kaudu (soovitatav)
composer require blockstudio/blockstudio
Blockstudio saab paigaldada pluginana composer/installers kaudu või lisada otse teema sisse. Kõigi paigaldusviiside kohta lugege Composer dokumentatsiooni.
Composer paigaldused saavad uuendusi Composer kaudu. Sisseehitatud GitHub uuendaja lülitatakse automaatselt välja.
Käsitsi paigaldamine
Laadige uusim väljalase alla aadressilt GitHub
Laadige zip-fail üles oma WordPress pluginate kataloogi ja aktiveerige plugin. Käsitsi paigaldatud pluginad saadavad automaatsete uuenduste teavitusi WordPress töölaual sisseehitatud GitHub uuendaja kaudu.
Mõlemad paigaldusviisid sisaldavad Markdown, YAML ja uuenduste teeke koos sõltuvustega eraldi privaatsete koopiatena. Need ei kasuta ega asenda versioone, mida pakub mõni teine plugin või teema. Kui teie rakendus kasutab mõnda neist teekidest otse, paigaldage oma Composer sõltuvus; Blockstudio komplekti kuuluvad koopiad on sisemised ega ole avalik PHP API.
Autenditud uuenduste kontrollimine
Käsitsi paigaldatud versioonid kontrollivad vaikimisi GitHub anonüümselt. Mitme saiti kasutamine sama väljuva IP kaudu võib ammendada GitHub anonüümsete API päringute limiidi ning uuenduste kontrollimisel saada vastuseks HTTP 403. Seadistage 7.7.4 kaudu failis wp-config.php isiklik GitHub juurdepääsutõend enne, kui laaditakse WordPress:
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');
Tõend vajab juurdepääsu ainult avaliku hoidla teabele. Ärge andke sellele kirjutamisõigust. Hoidke seda serveripoolses seadistuses, versioonihaldusest, blockstudio.json-st, ploki atribuutidest ja kasutajaliidese koodist eemal. Uuendaja edastab selle autenditud kontrollide ja väljalasete allalaadimise jaoks komplekti kuuluvale GitHub kliendile. Päringud mitteseotud hoidlatesse ja teistesse allalaadimisteenustesse tõendit kaasa ei saa.
Keskkonnamuutujatega hallatavate saladuste korral saab MU-plugin tõendi lisada või asendada:
<?php
add_filter('blockstudio/updater/token', function ($token) {
return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});
Filter käivitub siis, kui Blockstudio lähtestab oma uuendaja, enne teema laadimist. Registreerige see MU-pluginas, mitte failis functions.php. Tühja stringi tagastamine keelab autentimise isegi siis, kui konstant on määratletud. Tühjad või stringist erinevad väärtused jätavad kontrollid anonüümseks. Tõendid on valikulised; ilma nendeta jääb senine uuenduskäitumine samaks. Composer paigaldused kasutavad uuendusteks endiselt Composer ega lähtesta seda uuendajat.
Esimese ploki loomine
1. Looge ploki kataloog
Looge oma teemasse uus kataloog:
my-theme/
blockstudio/
my-first-block/
block.json
index.php
2. Määratlege ploki skeem
Looge fail block.json ploki konfiguratsiooniga:
{
"$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. Looge mall
Looge renderdamiseks fail index.php:
<div class="my-first-block">
<h2><?php echo $a['heading']; ?></h2>
<p><?php echo $a['content']; ?></p>
</div>
Mallide Twig kasutamine
Blockstudio toetab kohe kasutusvalmis Twig malle. Kasutage selle asemel lihtsalt index.twig:
<div class="my-first-block">
<h2>{{ a.heading }}</h2>
<p>{{ a.content }}</p>
</div>
Stiilide lisamine
Looge samasse kausta fail style.css:
.my-first-block {
padding: 2rem;
background: #f5f5f5;
}
Blockstudio lisab selle stiililehe automaatselt järjekorda, kui plokki kasutatakse.
Tõlked
Blockstudio redaktori juhtelemendid ja halduse ülevaade laadivad JavaScript tõlked WordPress kaudu tekstidomeenile blockstudio. Paigaldage sobiv keelepakett või looge oma tõlketööriistaga skriptitõlke JSON-failid asukohas wp-content/languages/plugins/. Stringid, millele tõlge puudub, jäävad ingliskeelseks. See tõlgib Blockstudio enda kasutajaliidese, mitte plokkides määratletud sisu ega väljade silte.
Järgmised sammud
Teie plokk on nüüd WordPress redaktoris kasutamiseks valmis. Jätkake dokumentatsiooni uurimist, et saada teada järgmisest:
- Väljatüübid – kõik saadaolevad väljatüübid
- Komponendid – InnerBlocks, RichText ja muud
- Tailwind integratsioon – Tailwind CSS kasutamine
- Hook’id – funktsionaalsuse laiendamine filtrite ja tegevuste abil
Liikuge üksikust plokist terve teegini: kujundustokenid, jaotise muster, kordajad, pildid ja lehe koostamine.