Ugrás a tartalomhoz

Kezdő lépések

Ez az útmutató segít beállítani a Blockstudio eszközt, és létrehozni az első egyéni blokkot.

Telepítés

Shell
composer require blockstudio/blockstudio

A Blockstudio bővítményként telepíthető a composer/installers segítségével, vagy közvetlenül egy témába is beépíthető. Az összes telepítési módért tekintse meg a Composer dokumentációját.

A Composer-telepítések a Composer rendszeren keresztül kapják a frissítéseket. A beépített GitHub frissítő automatikusan letiltásra kerül.

Kézi telepítés

Töltse le a legújabb kiadást innen: GitHub

Töltse fel a ZIP-fájlt a WordPress bővítmények könyvtárába, majd aktiválja a bővítményt. A kézi telepítések automatikus frissítési értesítéseket kapnak a WordPress vezérlőpulton keresztül, a beépített GitHub frissítő segítségével.

Mindkét telepítési módszer tartalmazza a Markdown, YAML és a frissítőkönyvtárak, valamint függőségeik saját, privát példányát. Nem használják és nem cserélik le más bővítmény vagy sablon által biztosított verziókat. Telepítse saját Composer függőségét, ha az alkalmazása közvetlenül használja e könyvtárak valamelyikét; a Blockstudio beépített példányai belső használatúak, nem nyilvános PHP API.

Hitelesített frissítés-ellenőrzések

A kézi telepítések alapértelmezés szerint névtelenül ellenőrzik a GitHub állapotát. Ha több webhely ugyanazt a kimenő IP-t használja, kimeríthetik a GitHub névtelen API-keretét, és frissítések ellenőrzésekor HTTP 403 válaszokat kaphatnak. A 7.7.4 konfigurálásakor állítson be egy GitHub személyes hozzáférési tokent a wp-config.php fájlban, mielőtt betöltődik a WordPress:

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

A tokennek csak a nyilvános tároló adataihoz kell hozzáférést biztosítania. Ne adjon írási jogosultságot. Tartsa szerveroldali konfigurációban, a verziókezelésen, a blockstudio.json attribútumain és a kezelőfelületi kódon kívül. A frissítő a beépített GitHub kliensnek adja át hitelesített ellenőrzésekhez és kiadások letöltéséhez. A tokent nem kapják meg a nem kapcsolódó tárolókhoz vagy más letöltési kiszolgálókhoz intézett kérések.

A környezet által kezelt titkok megadásához vagy felülírásához egy MU-bővítmény használható:

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

A szűrő akkor fut le, amikor a Blockstudio inicializálja a frissítőjét, még a sablon betöltése előtt. Regisztrálja egy MU-bővítményben, ne a functions.php fájlban. Az üres karakterlánc visszaadása letiltja a hitelesítést akkor is, ha a konstans definiálva van. Az üres vagy nem karakterlánc típusú értékek esetén az ellenőrzések névtelenül futnak. A token használata nem kötelező; nélküle a meglévő frissítési működés változatlan marad. A Composer telepítések továbbra is a Composer eszközt használják a frissítésekhez, és nem inicializálják ezt a frissítőt.

Az első blokk létrehozása

1. Blokk könyvtárának létrehozása

Hozzon létre egy új könyvtárat a témájában:

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

2. A blokk séma meghatározása

Hozza létre a block.json fájlt a blokk konfigurációjával:

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. A sablon létrehozása

A megjelenítéshez hozza létre a index.php fájlt:

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

Twig sablonok használata

A Blockstudio alapértelmezés szerint támogatja a Twig sablonokat. Egyszerűen használja helyettük a index.twig megoldást:

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

Stílusok hozzáadása

Hozzon létre egy style.css fájlt ugyanabban a mappában:

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

A Blockstudio automatikusan betölti ezt a stíluslapot a blokk használatakor.

Fordítások

A Blockstudio szerkesztői vezérlői és adminisztrációs áttekintője a WordPress segítségével tölti be a blockstudio szövegtartományhoz tartozó JavaScript fordításokat. Telepítsen megfelelő nyelvi csomagot, vagy készítsen szkriptfordítási JSON fájlokat a fordítóeszközével a wp-content/languages/plugins/ mappában. Az elérhető fordítás nélküli karakterláncok angolul maradnak. Ez a Blockstudio saját felületét fordítja le, nem pedig a blokkokban megadott tartalmat vagy mezőcímkéket.

Következő lépések

A blokk most már használatra kész a WordPress szerkesztőben. A dokumentáció további részeiben többek között ezekről tanulhat:

Blokkkönyvtár építése

Egyetlen blokktól a teljes könyvtárig: tervezési tokenek, szekcióminta, ismétlők, képek és oldalak összeállítása.