Preskoči na vsebino

Začetek

Ta vodnik vam bo pomagal nastaviti Blockstudio in ustvariti prvi blok po meri.

Namestitev

Lupina
composer require blockstudio/blockstudio

Blockstudio lahko namestite kot vtičnik prek composer/installers ali pa ga vključite neposredno v temo. V dokumentaciji Composer najdete vse načine namestitve.

Namestitve Composer prejemajo posodobitve prek Composer. Vgrajeni posodabljalnik GitHub je samodejno onemogočen.

Ročna namestitev

Prenesite najnovejšo izdajo z GitHub

Naložite datoteko zip v mapo z vtičniki WordPress in aktivirajte vtičnik. Ročno nameščene različice prejemajo samodejna obvestila o posodobitvah na nadzorni plošči WordPress prek vgrajenega posodabljalnika GitHub.

Oba načina namestitve vključujeta zasebne kopije knjižnic Markdown, YAML in za posodabljanje ter njihovih odvisnosti. Ne uporabljata različic, ki jih ponuja drug vtičnik ali tema, niti jih ne zamenjujeta. Če vaša aplikacija katero od teh knjižnic uporablja neposredno, namestite lastno odvisnost Composer; vključene kopije v Blockstudio so interne in niso del javnega PHP API.

Preverjanje posodobitev s preverjeno pristnostjo

Ročne namestitve privzeto anonimno preverjajo GitHub. Na več spletnih mestih, ki si delijo en odhodni IP, se lahko izčrpa anonimna omejitev API za GitHub, pri preverjanju posodobitev pa se vrnejo odgovori HTTP 403. V 7.7.4 pred nalaganjem WordPress nastavite osebni žeton za dostop GitHub v wp-config.php:

PHP
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');

Žeton potrebuje dostop samo do podatkov javnega repozitorija. Ne dodelite mu dovoljenj za pisanje. Shranite ga v strežniško konfiguracijo, zunaj sistema za nadzor različic ter zunaj blockstudio.json, atributov blokov in kode čelnega dela. Posodabljalnik ga posreduje vgrajenemu odjemalcu GitHub za preverjanje pristnosti in prenos izdaj. Zahteve za nepovezane repozitorije in druge gostitelje prenosov žetona ne prejmejo.

Za skrivnosti, upravljane z okoljem, lahko vtičnik MU zagotovi žeton ali prepiše njegovo vrednost:

PHP
<?php
add_filter('blockstudio/updater/token', function ($token) {
  return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});

Filter se izvede, ko Blockstudio inicializira svoj posodabljalnik, še preden se naloži tema. Registrirajte ga v vtičniku MU namesto v functions.php. Če vrnete prazen niz, onemogočite preverjanje pristnosti, tudi če je konstanta določena. Prazne vrednosti ali vrednosti, ki niso nizi, ohranijo anonimno preverjanje. Žetoni so neobvezni; brez njih se obstoječe delovanje posodabljanja ne spremeni. Namestitve Composer za posodobitve še vedno uporabljajo Composer in tega posodabljalnika ne inicializirajo.

Ustvarjanje prvega bloka

1. Ustvarite mapo bloka

Ustvarite novo mapo v svoji temi:

Koda
my-theme/
  blockstudio/
    my-first-block/
      block.json
      index.php

2. Določite shemo bloka

Ustvarite block.json s konfiguracijo bloka:

JSON
{
  "$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. Ustvarite predlogo

Ustvarite index.php za izris:

PHP
<div class="my-first-block">
  <h2><?php echo $a['heading']; ?></h2>
  <p><?php echo $a['content']; ?></p>
</div>

Uporaba predlog Twig

Blockstudio že podpira predloge Twig. Preprosto uporabite index.twig:

Twig
<div class="my-first-block">
  <h2>{{ a.heading }}</h2>
  <p>{{ a.content }}</p>
</div>

Dodajanje slogov

V isti mapi ustvarite datoteko style.css:

CSS
.my-first-block {
  padding: 2rem;
  background: #f5f5f5;
}

Blockstudio bo to slogovno predlogo samodejno dodal v čakalno vrsto, ko bo blok uporabljen.

Prevodi

Urejevalniški kontrolniki in skrbniški pregled v Blockstudio nalagajo prevode JavaScript za besedilno domeno blockstudio prek WordPress. Namestite ustrezen jezikovni paket ali z orodjem za prevajanje ustvarite datoteke JSON za prevode skript v wp-content/languages/plugins/. Nizi, za katere prevod ni na voljo, ostanejo v angleščini. S tem se prevede lasten vmesnik Blockstudio, ne pa vsebina ali oznake polj, ki jih določite v svojih blokih.

Naslednji koraki

Vaš blok je zdaj pripravljen za uporabo v urejevalniku WordPress. Nadaljujte z raziskovanjem dokumentacije in spoznajte:

Izdelava knjižnice blokov

Od enega bloka do celotne knjižnice: oblikovalski žetoni, vzorec razdelka, ponavljalniki, slike in sestavljanje strani.