Siirry sisältöön

Aloitus

Tämä opas auttaa sinua määrittämään Blockstudio-ympäristön ja luomaan ensimmäisen mukautetun lohkosi.

Asennus

Shell
composer require blockstudio/blockstudio

Blockstudio voidaan asentaa lisäosana palvelun composer/installers kautta tai sisällyttää suoraan teemaan. Katso Composer-dokumentaatiosta kaikki asennustavat.

Composer-asennukset saavat päivitykset palvelun Composer kautta. Sisäänrakennettu GitHub-päivitysohjelma poistetaan automaattisesti käytöstä.

Manuaalinen asennus

Lataa uusin julkaisu palvelusta GitHub

Lataa zip-tiedosto WordPress-lisäosahakemistoosi ja ota lisäosa käyttöön. Manuaaliset asennukset saavat automaattiset päivitysilmoitukset WordPress-hallintapaneelissa sisäänrakennetun GitHub-päivitysohjelman kautta.

Molemmat asennustavat sisältävät yksityiset kopiot kirjastoista Markdown, YAML ja päivitysohjelmista riippuvuuksineen. Ne eivät käytä tai korvaa toisen lisäosan tai teeman versioita. Asenna oma Composer-riippuvuutesi, jos sovelluksesi käyttää jotakin näistä kirjastoista suoraan; Blockstudion mukana toimitetut kopiot ovat sisäisiä eivätkä julkinen PHP API.

Tunnistautuneet päivitystarkistukset

Manuaaliset asennukset tarkistavat oletusarvoisesti GitHub-päivitykset nimettömästi. Useat sivustot, joilla on sama uloslähtevä IP, voivat käyttää loppuun GitHubn nimettömien API-pyyntöjen kiintiön ja saada päivityksiä tarkistaessaan vastauksiksi HTTP 403. Määritä kohdassa 7.7.4 henkilökohtainen GitHub-käyttöoikeustunnus tiedostossa wp-config.php ennen kuin WordPress latautuu:

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

Tunnus tarvitsee pääsyn vain julkisiin arkistotietoihin. Älä anna kirjoitusoikeuksia. Säilytä se palvelinpuolen asetuksissa, versionhallinnan ulkopuolella ja poissa blockstudio.json-asetuksista, lohkoattribuuteista ja käyttöliittymän koodista. Päivitysohjelma välittää sen mukana tulevalle GitHub-asiakasohjelmalle tunnistautuneita tarkistuksia ja julkaisutiedostojen latauksia varten. Pyyntöihin muihin arkistoihin tai latauspalvelimiin tunnusta ei liitetä.

Ympäristössä hallittavia salaisuuksia varten MU-lisäosa voi tarjota tunnuksen tai korvata sen:

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

Suodatin suoritetaan, kun Blockstudio alustaa päivitysohjelmansa, ennen teeman latautumista. Rekisteröi se MU-lisäosassa, älä tiedostossa functions.php. Tyhjän merkkijonon palauttaminen poistaa tunnistautumisen käytöstä, vaikka vakio olisi määritelty. Tyhjät tai muut kuin merkkijonoarvot jättävät tarkistukset nimettömiksi. Tunnukset ovat valinnaisia; ilman niitä päivitysten nykyinen toiminta säilyy. Composer-asennukset käyttävät päivityksiin edelleen Composer eivätkä alusta tätä päivitysohjelmaa.

Ensimmäisen lohkon luominen

1. Luo lohkon hakemisto

Luo teemaan uusi hakemisto:

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

2. Määritä lohkon skeema

Luo block.json lohkon määrityksilläsi:

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. Luo malli

Luo renderöintiä varten index.php:

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

Twig-mallien käyttäminen

Blockstudio tukee Twig-malleja sellaisenaan. Käytä vain sen sijaan muotoa index.twig:

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

Tyylien lisääminen

Luo style.css-tiedosto samaan kansioon:

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

Blockstudio lisää tämän tyylitiedoston automaattisesti jonoon, kun lohkoa käytetään.

Käännökset

Blockstudio-editorin ohjaimet ja ylläpidon yleisnäkymä lataavat JavaScript-käännökset tekstiverkkotunnukselle blockstudio palvelun WordPress kautta. Asenna vastaava kielipaketti tai luo käännöstyökalullasi skriptin käännös-JSON-tiedostot kansioon wp-content/languages/plugins/. Merkkijonot, joille ei ole saatavilla käännöstä, jäävät englanninkielisiksi. Tämä kääntää Blockstudio-ohjelman oman käyttöliittymän, ei lohkoissa määrittämääsi sisältöä tai kenttien nimiöitä.

Seuraavat vaiheet

Lohkosi on nyt valmis käytettäväksi WordPress-editorissa. Tutustu dokumentaatioon ja lue lisää seuraavista aiheista:

Lohkokirjaston rakentaminen

Siirry yksittäisestä lohkosta täyteen kirjastoon: suunnittelutunnisteet, osiohahmo, toistimet, kuvat ja sivujen sommittelu.