Interaktivität
Blockstudio unterstützt die WordPress Interactivity API, die eine standardisierte Möglichkeit bietet, deinen Blöcken reaktives Verhalten auf der Clientseite hinzuzufügen. Setze interactivity in deinem block.json, und Blockstudio übernimmt das Laden des API sowohl im Frontend als auch im Editor.
Konfiguration
Aktiviere die Interactivity API, indem du interactivity zum Schlüssel blockstudio in deinem block.json hinzufügst:
{
"name": "my-theme/interactive-block",
"title": "Interactive Block",
"category": "text",
"icon": "star-filled",
"description": "A block with interactive behavior.",
"blockstudio": {
"interactivity": true
}
}
Du kannst auch die Objektform verwenden:
{
"blockstudio": {
"interactivity": {
"enqueue": true
}
}
}
Beide Formen sind gleichwertig.
Vorlage
Füge deinem Block-Template Interactivity-API-Direktiven hinzu. Das Attribut data-wp-interactive definiert den Store-Namespace, während andere data-wp-*-Attribute das reaktive Verhalten steuern.
<div useBlockProps
data-wp-interactive="myBlock"
data-wp-context='{ "isOpen": false }'>
<button data-wp-on--click="actions.toggle"
data-wp-bind--aria-expanded="context.isOpen">
Toggle
</button>
<div data-wp-bind--hidden="!context.isOpen">
This content is toggled by the button.
</div>
</div>
Skript
Erstelle eine script.js-Datei in deinem Blockordner, importiere daraus @wordpress/interactivity und initialisiere deinen Store. Rufe store() auf oberster Modulebene auf:
import { store, getContext } from '@wordpress/interactivity';
store('myBlock', {
actions: {
toggle: () => {
const context = getContext();
context.isOpen = !context.isOpen;
},
},
});
Blockstudio lädt script.js als ES-Modul und erstellt automatisch die benötigte Import-Map, um @wordpress/interactivity aufzulösen.
Eine script.js wird nur benötigt, wenn dein Block eigene Aktionen oder Callbacks definiert. Blöcke, die ausschließlich deklarative Direktiven mit data-wp-context verwenden, etwa data-wp-bind--hidden oder data-wp-text, funktionieren ohne JavaScript.
Serverseitiger Zustand
Du kannst wp_interactivity_state() in deinem Template verwenden, um den Zustand aus PHP zu initialisieren:
<?php
wp_interactivity_state( 'myBlock', array(
'message' => 'Hello from the server',
'count' => get_comments_number(),
) );
?>
<div useBlockProps
data-wp-interactive="myBlock">
<p data-wp-text="state.message">loading...</p>
<p data-wp-text="state.count">0</p>
</div>
Serverseitiger Zustand ist nur im Frontend verfügbar. WordPress serialisiert den Zustand in ein JSON-Skript-Tag in der Seitenausgabe, das die Interactivity-API beim Hydrieren ausliest. Im Editor werden Blöcke über das REST API gerendert. Daher sind die Zustandsdaten nicht in der Antwort enthalten. Verwende data-wp-context für Zustände, die sowohl im Editor als auch im Frontend funktionieren müssen.
Callbacks und Aktionen
Aktionen werden durch Benutzerinteraktionen ausgelöst, etwa data-wp-on--click. Callbacks werden reaktiv ausgelöst, wenn sich Zustand oder Kontext ändern, und verwenden dazu die Direktive data-wp-watch. In Callbacks kannst du mit getElement() auf das zugrunde liegende DOM-Element zugreifen:
import { store, getContext, getElement } from '@wordpress/interactivity';
store('myBlock', {
callbacks: {
updateWidth: () => {
const { ref } = getElement();
const { isOpen } = getContext();
ref.style.width = isOpen ? '100%' : '0';
},
},
});
Editor-Unterstützung
Die Interactivity-API wird im Iframe des Blockeditors geladen, sodass interaktive Direktiven in Editor-Vorschauen funktionieren. Dazu gehören data-wp-context, data-wp-bind--*, data-wp-on--*, data-wp-text und benutzerdefinierte Store-Aktionen aus script.js.
Interaktive Komponenten erstellen
Vollständige Beispiele mit Akkordeons, Tabs, modalen Dialogen und Like-Buttons.