Hoppa till innehåll

Kom igång

Den här guiden hjälper dig att konfigurera Blockstudio och skapa ditt första anpassade block.

Installation

Shell
composer require blockstudio/blockstudio

Blockstudio kan installeras som ett tillägg via composer/installers eller paketeras direkt i ett tema. Se Composerdokumentationen för alla installationsmetoder.

Composer-installationer får uppdateringar via Composer. Den inbyggda uppdateraren för GitHub inaktiveras automatiskt.

Manuell installation

Hämta den senaste versionen från GitHub

Ladda upp zip-filen till tilläggskatalogen för WordPress och aktivera tillägget. Manuella installationer får automatiska uppdateringsaviseringar i kontrollpanelen för WordPress via den inbyggda uppdateraren för GitHub.

Båda installationsmetoderna paketerar privata kopior av biblioteken Markdown, YAML och för uppdatering samt deras beroenden. De använder inte och ersätter inte versioner som tillhandahålls av ett annat tillägg eller tema. Installera ditt eget beroende av Composer om din applikation använder något av dessa bibliotek direkt; Blockstudios paketerade kopior är interna, inte ett offentligt PHP API.

Autentiserade uppdateringskontroller

Manuella installationskontroller använder GitHub anonymt som standard. Flera webbplatser som delar en utgående IP kan förbruka GitHubs anonyma API-kvot och få HTTP 403-svar vid uppdateringskontroller. Konfigurera en personlig åtkomsttoken för GitHub i wp-config.php från 7.7.4, innan WordPress läses in:

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

Tokenen behöver bara åtkomst till offentlig arkivinformation. Ge den inga skrivbehörigheter. Förvara den i serverkonfigurationen, utanför versionshanteringen och utanför blockstudio.json, blockattribut och frontendkod. Uppdateraren skickar den till sin paketerade GitHub-klient för autentiserade kontroller och nedladdningar av releaser. Förfrågningar till orelaterade arkiv och andra nedladdningsvärdar får inte tokenen.

För hemligheter som hanteras via miljön kan ett MU-tillägg tillhandahålla eller åsidosätta tokenen:

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

Filtret körs när Blockstudio initierar sin uppdaterare, innan temat läses in. Registrera det i ett MU-tillägg i stället för i functions.php. Om du returnerar en tom sträng inaktiveras autentiseringen även om konstanten är definierad. Tomma värden eller värden som inte är strängar innebär att kontrollerna förblir anonyma. Token är valfria; utan en förblir befintligt uppdateringsbeteende oförändrat. Composer-installationer använder fortfarande Composer för uppdateringar och initierar inte den här uppdateraren.

Skapa ditt första block

1. Skapa en blockkatalog

Skapa en ny katalog i ditt tema:

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

2. Definiera blockschemat

Skapa block.json med din blockkonfiguration:

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. Skapa mallen

Skapa index.php för rendering:

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

Använda Twig-mallar

Blockstudio har inbyggt stöd för Twig-mallar. Använd bara index.twig i stället:

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

Lägga till stilar

Skapa en style.css-fil i samma mapp:

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

Blockstudio köar automatiskt detta stilmallblad när blocket används.

Översättningar

Blockstudios redigeringskontroller och administratörsöversikt läser in JavaScript-översättningar för textdomänen blockstudio via WordPress. Installera ett matchande språkpaket eller generera skriptöversättningsfiler JSON med ditt översättningsverktyg i wp-content/languages/plugins/. Strängar utan tillgänglig översättning förblir på engelska. Detta översätter Blockstudios eget gränssnitt, inte innehållet eller fältetiketterna som du definierar i dina block.

Nästa steg

Ditt block är nu klart att använda i redigeraren för WordPress. Fortsätt utforska dokumentationen för att lära dig mer om:

Bygga ett blockbibliotek

Gå från ett enskilt block till ett komplett bibliotek: designtoken, sektionsmönstret, upprepningsfält, bilder och sidkomposition.