Ga naar de inhoud

Aan de slag

Deze handleiding helpt je Blockstudio in te stellen en je eerste aangepaste blok te maken.

Installatie

Shell
composer require blockstudio/blockstudio

Blockstudio kan als plugin worden geïnstalleerd via composer/installers of rechtstreeks in een thema worden opgenomen. Raadpleeg de documentatieComposer voor alle installatiemethoden.

Composer-installaties ontvangen updates via Composer. De ingebouwde updater van GitHub wordt automatisch uitgeschakeld.

Handmatige installatie

Download de nieuwste versie van GitHub

Upload het zipbestand naar de pluginmap WordPress en activeer de plugin. Bij handmatige installaties ontvang je automatische updatemeldingen in het WordPress-dashboard via de ingebouwde updater van GitHub.

Beide installatiemethoden bundelen privéversies van de bibliotheken Markdown, YAML en voor updates, plus hun afhankelijkheden. Ze gebruiken of vervangen geen versies die door een andere plugin of een thema worden geleverd. Installeer uw eigen afhankelijkheid van Composer als uw applicatie een van die bibliotheken rechtstreeks gebruikt; de gebundelde kopieën van Blockstudio zijn intern en vormen geen openbare PHP API.

Geauthenticeerde updatecontroles

Handmatige installaties controleren standaard anoniem bij GitHub. Verschillende sites die één uitgaande IP delen, kunnen de anonieme API-limiet van GitHub opgebruiken en HTTP-antwoorden 403 ontvangen wanneer ze op updates controleren. Configureer vanuit 7.7.4 een persoonlijk access token voor GitHub in wp-config.php, voordat WordPress wordt geladen:

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

Het token heeft alleen toegang tot openbare repository-informatie nodig. Verleen geen schrijfrechten. Bewaar het in de serverconfiguratie, buiten versiebeheer en buiten blockstudio.json, blokattributen en frontendcode. De updater geeft het door aan de gebundelde client van GitHub voor geauthenticeerde controles en het downloaden van releases. Verzoeken aan niet-gerelateerde repositories en andere downloadhosts ontvangen het token niet.

Voor geheimen die door de omgeving worden beheerd, kan een MU-plugin het token aanleveren of overschrijven:

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

Het filter wordt uitgevoerd wanneer Blockstudio de updater initialiseert, voordat het thema wordt geladen. Registreer het in een MU-plugin in plaats van in functions.php. Een lege tekenreeks schakelt authenticatie uit, ook als de constante is gedefinieerd. Lege of niet-tekenreekswaarden zorgen ervoor dat controles anoniem blijven. Tokens zijn optioneel; zonder token blijft het bestaande updategedrag ongewijzigd. Installaties van Composer gebruiken voor updates nog steeds Composer en initialiseren deze updater niet.

Je eerste blok maken

1. Een blokmap maken

Maak een nieuwe map in je thema:

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

2. Het blokschema definiëren

Maak block.json met de configuratie van je blok:

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. Het sjabloon maken

Maak index.php om het blok weer te geven:

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

Twig-sjablonen gebruiken

Blockstudio ondersteunt standaard Twig-sjablonen. Gebruik eenvoudigweg index.twig:

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

Stijlen toevoegen

Maak een bestand style.css in dezelfde map:

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

Blockstudio voegt dit stylesheet automatisch toe wanneer het blok wordt gebruikt.

Vertalingen

De editorbediening en het adminoverzicht van Blockstudio laden JavaScript-vertalingen voor het tekstdomein blockstudio via WordPress. Installeer een passend taalpakket of genereer scriptvertalingsbestanden JSON met je vertaaltool in wp-content/languages/plugins/. Strings zonder beschikbare vertaling blijven in het Engels. Dit vertaalt de eigen interface van Blockstudio, niet de inhoud of veldlabels die je in je blokken definieert.

Volgende stappen

Je blok is nu klaar voor gebruik in de WordPress-editor. Verken de documentatie verder om meer te leren over:

Een blokbibliotheek bouwen

Ga van één blok naar een complete bibliotheek: ontwerptokens, het sectiepatroon, repeaters, afbeeldingen en paginacompositie.