Erste Schritte
Diese Anleitung hilft dir dabei, Blockstudio einzurichten und deinen ersten benutzerdefinierten Block zu erstellen.
Installation
Über Composer (empfohlen)
composer require blockstudio/blockstudio
Blockstudio kann als Plugin über composer/installers installiert oder direkt in ein Theme eingebunden werden. Alle Installationsmethoden findest du in der Composer-Dokumentation.
Bei Composer-Installationen erfolgen Updates über Composer. Der integrierte GitHub-Updater wird automatisch deaktiviert.
Manuelle Installation
Lade die neueste Version von GitHub herunter
Lade die ZIP-Datei in dein WordPress-Pluginverzeichnis hoch und aktiviere das Plugin. Bei manuellen Installationen erhältst du automatische Update-Benachrichtigungen im WordPress-Dashboard über den integrierten GitHub-Updater.
Beide Installationsmethoden bündeln private Kopien der Bibliotheken Markdown, YAML und für Updates sowie ihrer Abhängigkeiten. Sie verwenden oder ersetzen keine Versionen, die von einem anderen Plugin oder Theme bereitgestellt werden. Installiere deine eigene Abhängigkeit Composer, wenn deine Anwendung eine dieser Bibliotheken direkt verwendet; die gebündelten Kopien von Blockstudio sind intern und keine öffentliche PHP API.
Authentifizierte Update-Prüfungen
Manuelle Installationen prüfen GitHub standardmäßig anonym. Mehrere Websites, die sich eine ausgehende IP teilen, können das anonyme API-Kontingent von GitHub ausschöpfen und bei der Suche nach Updates Antworten mit dem Status HTTP 403 erhalten. Konfiguriere in 7.7.4 ein persönliches Zugriffstoken GitHub in wp-config.php, bevor WordPress geladen wird:
define('BLOCKSTUDIO_GITHUB_TOKEN', 'your-github-token');
Das Token benötigt nur Zugriff auf öffentliche Repository-Informationen. Vergib keine Schreibberechtigungen. Bewahre es in der serverseitigen Konfiguration auf, außerhalb der Versionsverwaltung, der Attribute von blockstudio.json-Blöcken und des Frontend-Codes. Der Updater übergibt es seinem gebündelten GitHub-Client für authentifizierte Prüfungen und Release-Downloads. Anfragen an andere Repositories und Download-Hosts erhalten das Token nicht.
Für umgebungsverwaltete Geheimnisse kann ein MU-Plugin das Token bereitstellen oder überschreiben:
<?php
add_filter('blockstudio/updater/token', function ($token) {
return getenv('BLOCKSTUDIO_GITHUB_TOKEN') ?: $token;
});
Der Filter wird ausgeführt, wenn Blockstudio seinen Updater initialisiert, bevor das Theme geladen wird. Registriere ihn in einem MU-Plugin statt in functions.php. Die Rückgabe einer leeren Zeichenfolge deaktiviert die Authentifizierung, auch wenn die Konstante definiert ist. Leere oder nicht als Zeichenfolge vorliegende Werte lassen Prüfungen anonym. Tokens sind optional; ohne Token bleibt das bestehende Update-Verhalten unverändert. Composer-Installationen verwenden weiterhin Composer für Updates und initialisieren diesen Updater nicht.
Deinen ersten Block erstellen
1. Blockverzeichnis erstellen
Erstelle ein neues Verzeichnis in deinem Theme:
my-theme/
blockstudio/
my-first-block/
block.json
index.php
2. Blockschema definieren
Erstelle block.json mit deiner Blockkonfiguration:
{
"$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. Template erstellen
Erstelle index.php zum Rendern:
<div class="my-first-block">
<h2><?php echo $a['heading']; ?></h2>
<p><?php echo $a['content']; ?></p>
</div>
Twig-Templates verwenden
Blockstudio unterstützt Twig-Templates standardmäßig. Verwende einfach stattdessen index.twig:
<div class="my-first-block">
<h2>{{ a.heading }}</h2>
<p>{{ a.content }}</p>
</div>
Styles hinzufügen
Erstelle eine style.css-Datei im selben Ordner:
.my-first-block {
padding: 2rem;
background: #f5f5f5;
}
Blockstudio bindet dieses Stylesheet automatisch ein, wenn der Block verwendet wird.
Übersetzungen
Die Editor-Steuerelemente und die Admin-Übersicht von Blockstudio laden Übersetzungen von JavaScript für die Textdomain blockstudio über WordPress.
Installiere ein passendes Sprachpaket oder erstelle mit deinem Übersetzungstool Script-Übersetzungsdateien JSON in wp-content/languages/plugins/. Zeichenfolgen ohne verfügbare Übersetzung bleiben auf Englisch. Dadurch wird die eigene Benutzeroberfläche von Blockstudio übersetzt, nicht die Inhalte oder Feldbeschriftungen, die du in deinen Blöcken definierst.
Nächste Schritte
Dein Block ist jetzt im WordPress-Editor einsatzbereit. In der Dokumentation erfährst du mehr über:
- Feldtypen – alle verfügbaren Feldtypen
- Komponenten – InnerBlocks, RichText und mehr
- Tailwind-Integration – Tailwind CSS verwenden
- Hooks – Funktionalität mit Filtern und Aktionen erweitern
Eine Blockbibliothek erstellen
Entwickle aus einem einzelnen Block eine vollständige Bibliothek: mit Design-Tokens, dem Abschnittsmuster, Repeatern, Bildern und Seitenkomposition.