Zum Inhalt springen

Eigene Blöcke in 3 Dateien

Kein JavaScript, kein Build-Schritt, kein Boilerplate.

Felder in JSON definieren

Füge blockstudio zu block.json hinzu. Definiere Attribute mit Typen wie text, toggle und color. Blockstudio generiert automatisch den Editor UI mit 27 Feldtypen – von Texteingaben über Repeater bis hin zu Code-Editoren – sowie Feldtypen, die du selbst registrierst.

Die vollständige Unterstützung für JSON-Schema bietet Autovervollständigung und Validierung in VS Code, PhpStorm und allen kompatiblen Editoren.

Für jedes Feld kannst du einen default für neue Blöcke und einen fallback festlegen, den die Vorlage erhält, solange das Feld leer ist.

block.json
{
  "name": "starter/hero",
  "title": "Hero",
  "blockstudio": {
    "attributes": [
      { "id": "heading", "type": "text", "label": "Heading" },
      { "id": "showCta", "type": "toggle", "label": "Show CTA" },
      { "id": "background", "type": "color", "label": "Background" }
    ]
  }
}

Workflow mit 3 Dateien

block.json für Felder, ein Template für Markup und ein optionales Stylesheet.

React in PHP

RichText, InnerBlocks und useBlockProps funktionieren direkt in PHP, Twig oder Blade.

SCSS und Tailwind

Verwende CSS, SCSS oder Tailwind. SCSS unterstützt Importpfade und einen gemeinsamen Präambeltext; wenn du ein verschachteltes Partial bearbeitest, werden alle Dateien neu kompiliert, die es importieren.

27 Feldtypen

Text, Farbe, Bild, Repeater, Auswahlfeld, Code-Editor und mehr – konfiguriert in JSON.

JSON Schema

Autovervollständigung und Validierung in VS Code, PhpStorm und kompatiblen Editoren.

Drei Template-Sprachen

PHP, Twig und Blade verwenden dieselben Variablen und Komponenten.

npm-Importe

Importiere Pakete in script.js; lokal in der Produktion und über CDN im Editor.

Interactivity API

Aktiviere WordPress Interactivity API mit einem Flag.

React-Komponenten in PHP-Templates

Verwende <RichText /> für Inline-Bearbeitung und statisches Frontend-HTML, <InnerBlocks /> für untergeordnete Blöcke und useBlockProps für den Wrapper – alles in einem Template.

Im Editor werden daraus echte React-Komponenten. Im Frontend werden sie als serverseitiges HTML ausgegeben, ohne dass JavaScript an Besucher ausgeliefert wird.

index.php
<div useBlockProps class="container">
  <RichText
    class="text-xl font-semibold"
    tag="h1"
    attribute="headline"
    placeholder="Enter headline"
  />

  <?php if ($a['showCta']): ?>
    <a href="<?= esc_url($a['ctaUrl']) ?>">
      <?= esc_html($a['ctaLabel']) ?>
    </a>
  <?php endif; ?>

  <InnerBlocks class="mt-4 p-4 border" />
</div>

Mit PHP, Twig oder Blade schreiben

Verwende die Vorlagensprache, die du kennst. PHP funktioniert direkt, Twig läuft nach der Installation von Timber, und Blade läuft auf illuminate/view 8 bis 12 über Blockstudio\Blade_Renderer. Variablen, Komponenten und Verhalten bleiben gleich.

$a (Attribute), $b (Block), $c (Kontext) und $innerBlocks sind in jeder Sprache verfügbar.

Twig-Vorlagen erhalten außerdem den vollständigen Timber-Kontext. Auch Blade rendert Seiten, Muster und Vorlagen des Site-Editors. Der ältere jenssegers/blade-Wrapper funktioniert ab illuminate/view 10 nicht mehr; verwende stattdessen Blade_Renderer.

index.twig
<div useBlockProps class="card">
  <RichText tag="h2" attribute="title" placeholder="Card title" />
  {% if a.image %}
    <img src="{{ a.image.url|esc_url }}"
      alt="{{ a.image.alt|esc_attr }}" />
  {% endif %}
  <div class="card__body">{{ a.description|esc_html }}</div>
  <InnerBlocks allowedBlocks='["core/button"]' />
</div>

Bedingte Logik und dynamische Optionen

Blende Felder mit Operatoren wie ==, !=, includes und empty sowie Vergleichen ein oder aus. Verknüpfe Bedingungen mit ODER.

Optionen können von einem anderen Feld abhängen. Füge {attributes.post_type.value} zu den Populate-Argumenten hinzu, damit die Liste neu geladen wird, wenn sich dieses Feld ändert. Ergänze fetch: true, um Beiträge zu durchsuchen, während der Editor tippt.

Teile mit type: custom und dem Filter blockstudio/blocks/attributes/populate eine Optionsliste über mehrere Blöcke hinweg und registriere über blockstudio/blocks/conditions eigene globale Bedingungen, etwa eine Kaufprüfung.

block.json
{
  "name": "starter/posts",
  "title": "Posts",
  "blockstudio": {
    "attributes": [
      {
        "id": "post_type",
        "type": "select",
        "label": "Post type",
        "options": [
          { "value": "page", "label": "Pages" },
          { "value": "post", "label": "Posts" }
        ]
      },
      {
        "id": "selected_post",
        "type": "select",
        "label": "Post",
        "populate": {
          "type": "query",
          "query": "posts",
          "arguments": { "post_type": "{attributes.post_type.value}" }
        }
      },
      {
        "id": "style",
        "type": "select",
        "label": "Style",
        "populate": { "type": "custom", "custom": "cardStyles" },
        "conditions": [[
          { "type": "purchasedProduct", "operator": "==", "value": "yes" }
        ]]
      }
    ]
  }
}

Repeater, die überschaubar bleiben

Lege min und max fest, starte neue Blöcke mit default Zeilen und klappe vorhandene Zeilen mit minimized ein. textMinimized beschriftet eine eingeklappte Zeile mit einem ihrer eigenen Felder, etwa einem Namen.

Zeilen akzeptieren alle Feldtypen außer Tabs, auch verschachtelte Repeater. Eine Bedingung innerhalb einer Zeile prüft mit "context": "main" ein Feld außerhalb der Zeile. Mit <RichText /> und <MediaPlaceholder /> bearbeitest du eine einzelne Zeile, wenn ihr attribute auf repeaterId[index].fieldId verweist.

block.json
{
  "name": "starter/team",
  "title": "Team",
  "blockstudio": {
    "attributes": [
      {
        "id": "members",
        "type": "repeater",
        "label": "Team members",
        "min": 1,
        "max": 12,
        "minimized": true,
        "textMinimized": { "id": "name", "fallback": "Team member" },
        "attributes": [
          { "id": "name", "type": "text", "label": "Name" },
          { "id": "bio", "type": "richtext", "label": "Bio" }
        ]
      }
    ]
  }
}

Wiederverwendbare Feldgruppen

Definiere eine Feldgruppe einmal in einem field.json und binde sie mit "type": "custom/cta" in beliebige Blöcke ein. Die Felder werden direkt eingefügt, sodass Vorlagen sie wie jedes andere Attribut auslesen.

Verwende dieselbe Gruppe zweimal mit einem idStructure wie hero_{id} und passe Beschriftungen, Standardwerte oder Bedingungen pro Block mit overrides an. Der Feldtyp block macht dasselbe mit einem ganzen Block: Er fügt dessen Felder direkt ein und gibt dessen gerendertes HTML zurück.

fields/cta/field.json
{
  "name": "cta",
  "title": "Call to action",
  "attributes": [
    { "id": "label", "type": "text", "label": "Button label", "default": "Learn more" },
    { "id": "url", "type": "link", "label": "Button URL" }
  ]
}

ES-Module ohne Build-Schritt

Füge script.js hinzu; es wird als ES-Modul geladen. Importiere npm-Pakete mit dem Präfix npm:, und Blockstudio lädt sie für den Produktionseinsatz lokal herunter.

Der Editor zeigt sofort eine Vorschau, während das Frontend lokale Module ohne externe Abhängigkeiten verwendet, die nur einmal eingebunden werden.

Stylesheets werden auf dieselbe Weise importiert. import "npm:swiper@11.0.0/swiper.min.css" lädt die Datei herunter und bindet sie pro Version einmal ein, selbst wenn mehrere Blöcke sie verwenden.

script.js
import Swiper from "npm:swiper@11.0.0";
import "npm:swiper@11.0.0/swiper.min.css";

for (const el of document.querySelectorAll(".swiper")) {
  new Swiper(el, {
    slidesPerView: 3,
    spaceBetween: 20,
    loop: true,
  });
}

Block-Tags über Vorlagen hinaus

Ordne in blockstudio.json ein kurzes Präfix einem Namespace zu oder weise mit einem Alias-Filter ein Tag einem Block zu; <acme-card> rendert acme/card. Aktiviere blockTags.enabled, um Tags in Beitragsinhalten und Widgets zu rendern, begrenzt durch die Muster allow und deny.

data-*-Attribute gelangen zum Stammelement des Blocks; html-*-Attribute kommen dort ohne Präfix an. Füge mit blockstudio/block_tags/builders eigene Tag-Builder hinzu und wandle Kurzformen mit dem Befehl migrate-block-tags in die portable Schreibweise <bs:acme-card> um.

blockstudio.json
{
  "blockTags": {
    "enabled": true,
    "prefixes": {
      "acme": ["acme"],
      "ui": ["acme-ui"]
    },
    "deny": ["acme-ui/admin-*"]
  }
}

Benutzerdefinierte Feldtypen

Registriere dein eigenes Feld-Steuerelement und verwende es wie ein integriertes Feld.

Block-Inseln

Cach die gesamte Seite und rendere einen Block während der Anfrage des Besuchers.

Bedingte Registrierung

Registriere einen Block nur für einen Beitragstyp, eine Benutzerrolle oder eine andere globale Bedingung. Du kannst ihn auch überspringen, wenn ein benötigtes Plugin oder eine erforderliche Plugin-Version fehlt.

Beitragsmetadaten und Optionen

Speichere Werte neben den Blockattributen in Beitragsmetadaten oder Optionen.

Bedingte Logik

Zeige Felder abhängig von Werten anhand von Gleichheit, Zugehörigkeit, Leere und Vergleichen an.

Dynamische Datenquellen

Befülle Auswahlmöglichkeiten mit Beiträgen, Nutzern, Begriffen, Funktionen oder APIs.

Überschreibungen

Setze für einen gemeinsamen Block mit dessen Namen override: true, um Attribute anhand der ID zusammenzuführen, Assets mit übereinstimmenden Dateinamen zu ersetzen und die Vorlage auszutauschen. Vorlagen von Twig können einzelne Blöcke mit extends überschreiben.

Varianten

Lege Varianten in block.json fest, die Feldwerte vorgeben, und blende das steuernde Feld mit hidden aus.

Komponenten

Setze für einen Block, der ausschließlich über PHP oder Block-Tags gerendert wird, component: true. So bleiben Felder, Vorlagen, Assets und Tailwind erhalten, der Block erscheint jedoch nicht im Inserter.

InnerBlocks-Regeln

Erlaube Blöcke mit namespace/*-, category:- und @theme-Tokens, wechsle die innere Vorlage über eine Select-Option und entferne das Wrapper-Element im Frontend mit einem Filter.

Assets für Codefelder

Ein Codefeld mit asset: true wandelt Editor-Eingaben für diesen Block in CSS, SCSS oder JavaScript um; über %selector% wird der Geltungsbereich auf die jeweilige Instanz beschränkt.

Assets anhand des Dateinamens

*.view.js wird nur im Frontend geladen. Die Präfixe global-, admin- und block-editor- laden eine Datei auf jeder Seite, in wp-admin beziehungsweise im Block-Editor.

Icons und Block-Ordner

Gib einem Block ein eigenes SVG- oder HTML-Icon, ändere mit dem blockstudio/path-Filter den Speicherort für die Suche und füge Ordner mit Blockstudio\Build::init() hinzu.

Werte ACF und Meta Box

Vorlagen erhalten $post_id, sodass get_field() und rwmb_get_value() den bearbeiteten Beitrag auslesen. refreshOn lädt nach dem Speichern die Vorschau neu.

Kontext der Query Loop

Innerhalb einer Query Loop folgt $block[‘context’][‘postId’] dem aktuellen Element, während $block[‘postId’] beim gerade angezeigten Beitrag bleibt.

WPML

wp bs wpml config schreibt die wpml-config.xml, die Textfelder als übersetzbar kennzeichnet. Bilder, die in Feldern gespeichert sind, werden zusammen mit ihren Alternativtexten und Bildunterschriften in die Übersetzungsaufträge von WPML aufgenommen.

Plus

Das offizielle Erweiterungspaket

Premium-Websitevorlagen, KI-Systemanweisungen und eine private Discord-Community. Einmaliger Kauf, Updates auf Lebenszeit.

  • 500+ Website-Vorlagen
  • KI-Systemanweisungen
  • Updates auf Lebenszeit
  • Private Discord-Community