Pereiti prie turinio

Darbo pradžia

Šis vadovas padės jums įdiegti Blockstudio ir sukurti pirmąjį pasirinktinį bloką.

Diegimas

Shell
composer require blockstudio/blockstudio

Blockstudio galima įdiegti kaip papildinį per composer/installers arba tiesiogiai įtraukti į temą. Visus diegimo būdus rasite Composerdokumentacijoje.

Composer diegimai atnaujinami per Composer. Įtaisytasis GitHub atnaujinimo įrankis automatiškai išjungiamas.

Diegimas rankiniu būdu

Atsisiųskite naujausią versiją iš GitHub

Įkelkite zip failą į savo WordPress papildinių katalogą ir suaktyvinkite papildinį. Įdiegus rankiniu būdu, pranešimai apie naujinimus rodomi WordPress valdymo skydelyje per įtaisytąjį GitHub naujinimo įrankį.

Abu diegimo būdai apima privačias Markdown, YAML ir atnaujinimo bibliotekų kopijas bei jų priklausomybes. Jos nenaudoja ir nepakeičia kitų papildinių ar temų pateikiamų versijų. Jei jūsų programa tiesiogiai naudoja vieną iš šių bibliotekų, įdiekite savo Composer priklausomybę; Blockstudio komplekte esančios kopijos yra vidinės, o ne viešos PHP API.

Autentifikuoti naujinimų tikrinimai

Rankiniu būdu įdiegtos sistemos pagal numatytuosius nustatymus tikrina GitHub anonimiškai. Kelioms svetainėms, naudojančioms tą patį išeinantį IP, gali pritrūkti GitHub anoniminės API kvotos, todėl tikrinant, ar yra naujinimų, gaunami HTTP 403 atsakymai. Nuo 7.7.4 sukonfigūruokite wp-config.php asmeninį prieigos žetoną GitHub prieš įkeliant WordPress:

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

Žetonui reikia prieigos tik prie viešos saugyklos informacijos. Nesuteikite rašymo teisių. Laikykite jį serverio konfigūracijoje, už versijų valdymo sistemos ribų ir ne blockstudio.json, blokų atributuose ar sąsajos kode. Atnaujinimo programa perduoda jį savo komplekte esančiam GitHub klientui autentifikuotiems tikrinimams ir leidimų atsisiuntimams. Užklausoms į nesusijusias saugyklas ir kitus atsisiuntimo serverius žetonas neperduodamas.

Paslapčių valdymui per aplinką MU papildinys gali pateikti žetoną arba pakeisti jo reikšmę:

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

Filtras paleidžiamas, kai Blockstudio inicijuoja savo atnaujinimo programą, prieš įkeliant temą. Užregistruokite jį MU papildinyje, o ne functions.php. Grąžinus tuščią eilutę, autentifikavimas išjungiamas, net jei konstanta apibrėžta. Tuščios arba eilutės tipo neturinčios reikšmės reiškia, kad tikrinimai atliekami anonimiškai. Žetonai neprivalomi; be jų esama naujinimų elgsena nesikeičia. Composer diegimai naujinimams vis dar naudoja Composer ir šios atnaujinimo programos neinicijuoja.

Pirmojo bloko kūrimas

1. Sukurkite bloko katalogą

Sukurkite naują katalogą savo temoje:

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

2. Apibrėžkite bloko schemą

Sukurkite block.json su bloko konfigūracija:

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. Sukurkite šabloną

Atvaizdavimui sukurkite index.php:

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

Twig šablonų naudojimas

Blockstudio iškart palaiko Twig šablonus. Tiesiog naudokite index.twig:

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

Stilių pridėjimas

Tame pačiame aplanke sukurkite style.css failą:

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

Kai blokas naudojamas, Blockstudio automatiškai įtrauks šį stilių failą.

Vertimai

Blockstudio redaktoriaus valdikliams ir administravimo apžvalgai įkelia JavaScript vertimus teksto domenui blockstudio per WordPress. Įdiekite tinkamą kalbos paketą arba vertimo įrankiu sugeneruokite scenarijaus vertimo JSON failus wp-content/languages/plugins/. Eilutės, kurioms vertimo nėra, lieka anglų kalba. Taip išverčiama tik paties Blockstudio sąsaja, o ne turinys ar laukų etiketės, kurias apibrėžiate savo blokuose.

Tolesni žingsniai

Dabar jūsų bloką galima naudoti WordPress redaktoriuje. Skaitykite toliau dokumentaciją ir sužinokite apie:

Blokų bibliotekos kūrimas

Nuo vieno bloko pereikite prie visos bibliotekos: dizaino žymos, sekcijų šablonas, kartotuvai, vaizdai ir puslapių komponavimas.