Přejít k obsahu

Začínáme

Tento průvodce vám pomůže nastavit Blockstudio a vytvořit první vlastní blok.

Instalace

Shell
composer require blockstudio/blockstudio

Blockstudio lze nainstalovat jako plugin přes composer/installers nebo přidat přímo do šablony. Všechny způsoby instalace najdete v dokumentaci Composer.

Instalace Composer dostávají aktualizace přes Composer. Vestavěný aktualizátor GitHub se automaticky deaktivuje.

Ruční instalace

Stáhněte si nejnovější verzi z GitHub

Nahrajte soubor zip do adresáře pluginů WordPress a plugin aktivujte. Ručně instalované pluginy dostávají automatická oznámení o aktualizacích na nástěnce WordPress prostřednictvím vestavěného aktualizátoru GitHub.

Obě metody instalace obsahují soukromé kopie knihoven Markdown, YAML a aktualizátoru i jejich závislostí. Nepoužívají ani nenahrazují verze poskytované jiným pluginem nebo šablonou. Pokud vaše aplikace některou z těchto knihoven používá přímo, nainstalujte si vlastní závislost Composer; přibalené kopie Blockstudio jsou interní, nikoli veřejné rozhraní PHP API.

Ověřování aktualizací s autentizací

Ruční instalace standardně kontrolují GitHub anonymně. Několik webů sdílejících jedno odchozí IP může vyčerpat anonymní limit API pro GitHub a při kontrole aktualizací dostávat odpovědi HTTP 403. V 7.7.4 nastavte osobní přístupový token GitHub v wp-config.php, než se načte WordPress:

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

Token potřebuje přístup pouze k informacím o veřejných repozitářích. Neudělujte mu oprávnění k zápisu. Uchovávejte ho v konfiguraci na straně serveru, mimo správu verzí, blockstudio.json, atributy bloků i kód frontendu. Aktualizátor ho předává přibalenému klientovi GitHub pro ověřené kontroly a stahování vydání. Požadavky na nesouvisející repozitáře a jiné servery pro stahování token neobdrží.

Pro tajné údaje spravované prostředím může MU plugin token dodat nebo přepsat:

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

Filtr se spustí, když Blockstudio inicializuje svůj aktualizátor, ještě před načtením šablony. Zaregistrujte ho v MU pluginu, nikoli v functions.php. Vrácením prázdného řetězce vypnete autentizaci, i když je konstanta definována. Prázdné hodnoty nebo hodnoty jiného typu než řetězec ponechají kontroly anonymní. Tokeny jsou volitelné; bez tokenu zůstane stávající chování aktualizací beze změny. Instalace Composer při aktualizacích nadále používají Composer a tento aktualizátor neinicializují.

Vytvoření prvního bloku

1. Vytvořte adresář bloku

Vytvořte ve své šabloně nový adresář:

Kód
my-theme/
  blockstudio/
    my-first-block/
      block.json
      index.php

2. Definujte schéma bloku

Vytvořte block.json s konfigurací bloku:

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. Vytvořte šablonu

Vytvořte index.php pro vykreslování:

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

Použití šablon Twig

Blockstudio podporuje šablony Twig ihned po instalaci. Jednoduše místo toho použijte index.twig:

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

Přidání stylů

Ve stejné složce vytvořte soubor style.css:

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

Blockstudio při použití bloku automaticky zařadí tento soubor se styly do fronty.

Překlady

Blockstudio editor a přehled administrace načítají překlady JavaScript pro textovou doménu blockstudio prostřednictvím WordPress. Nainstalujte odpovídající jazykový balíček nebo pomocí překladového nástroje v wp-content/languages/plugins/ vygenerujte soubory JSON s překlady skriptů. Řetězce bez dostupného překladu zůstávají v angličtině. Tím se překládá vlastní rozhraní Blockstudio, nikoli obsah ani popisky polí, které definujete ve svých blocích.

Další kroky

Váš blok je nyní připraven k použití v editoru WordPress. Prozkoumejte další dokumentaci a zjistěte více o těchto tématech:

Vytvoření knihovny bloků

Rozšiřte jeden blok na celou knihovnu: návrhové tokeny, vzor sekce, opakovače, obrázky a skládání stránek.