Gå til indhold

Kom godt i gang

Denne vejledning hjælper dig med at opsætte Blockstudio og oprette din første brugerdefinerede blok.

Installation

Shell
composer require blockstudio/blockstudio

Blockstudio kan installeres som et plugin via composer/installers eller inkluderes direkte i et tema. Se dokumentationen til Composer for alle installationsmetoder.

Composer-installationer modtager opdateringer via Composer. Den indbyggede opdateringsfunktion i GitHub deaktiveres automatisk.

Manuel installation

Download den seneste udgivelse fra GitHub

Upload zipfilen til pluginmappen i WordPress, og aktivér pluginet. Manuelle installationer modtager automatiske opdateringsmeddelelser i kontrolpanelet i WordPress via den indbyggede opdateringsfunktion i GitHub.

Begge installationsmetoder samler private kopier af bibliotekerne Markdown, YAML og opdateringsbibliotekerne samt deres afhængigheder. De bruger eller erstatter ikke versioner, der leveres af et andet plugin eller tema. Installér din egen Composer-afhængighed, hvis din applikation bruger et af disse biblioteker direkte; Blockstudios samlede kopier er interne, ikke en offentlig PHP API.

Godkendte opdateringstjek

Manuelle installationer tjekker som standard GitHub anonymt. Flere websteder, der deler én udgående IP, kan opbruge GitHubs anonyme API-kvote og modtage HTTP 403-svar, når de tjekker efter opdateringer. Konfigurér et personligt adgangstoken for 7.7.4 i wp-config.php fra GitHub, før WordPress indlæses:

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

Tokenet behøver kun adgang til offentlige oplysninger om arkivet. Giv ikke skriveadgang. Opbevar det i serverkonfigurationen, uden for versionsstyring og væk fra blockstudio.json, blokattributter og frontendkode. Opdateringsprogrammet giver det videre til sin medfølgende GitHub-klient til godkendte tjek og download af udgivelser. Forespørgsler til uvedkommende arkiver og andre downloadværter modtager ikke tokenet.

Til hemmeligheder, der administreres via miljøet, kan et MU-plugin levere eller tilsidesætte tokenet:

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

Filteret køres, når Blockstudio initialiserer sit opdateringsprogram, før temaet indlæses. Registrér det i et MU-plugin i stedet for functions.php. Hvis der returneres en tom streng, deaktiveres godkendelse, selv når konstanten er defineret. Tomme værdier eller værdier, der ikke er strenge, medfører anonyme tjek. Token er valgfrit; uden et er den eksisterende opdateringsadfærd uændret. Composer-installationer bruger fortsat Composer til opdateringer og initialiserer ikke dette opdateringsprogram.

Opret din første blok

1. Opret en blokmappe

Opret en ny mappe i dit tema:

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

2. Definér blokkens skema

Opret block.json med din blokkonfiguration:

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. Opret skabelonen

Opret index.php til rendering:

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

Brug af Twig-skabeloner

Blockstudio understøtter Twig-skabeloner direkte. Brug blot index.twig i stedet:

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

Tilføj typografier

Opret en style.css-fil i samme mappe:

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

Blockstudio vil automatisk sætte dette typografiark i kø, når blokken bruges.

Oversættelser

Blockstudio’s editorstyring og administratoroversigt indlæser oversættelser til tekstområdet JavaScript for domænet blockstudio via WordPress. Installér en tilsvarende sprogpakke, eller generér scriptoversættelsesfiler JSON med dit oversættelsesværktøj i wp-content/languages/plugins/. Strenge uden en tilgængelig oversættelse forbliver på engelsk. Dette oversætter Blockstudio’s egen grænseflade, ikke indholdet eller feltetiketterne, du definerer i dine blokke.

Næste trin

Din blok er nu klar til brug i editoren WordPress. Fortsæt med at udforske dokumentationen for at lære om:

Byg et blokbibliotek

Gå fra en enkelt blok til et helt bibliotek: designtokens, sektionsmønsteret, gentagelsesfelter, billeder og sidelayout.