Zum Inhalt springen

Speicherung

Standardmäßig werden alle Feldwerte als Blockattribute im Blockkommentar innerhalb des Beitragsinhalts gespeichert. Mit der Speicherfunktion kannst du Werte zusätzlich in Beitragsmetadaten (wp_postmeta) oder Optionen (wp_options) speichern, damit sie auch außerhalb des Blockkontexts verfügbar sind.

Warum Speicherung verwenden?

Blockattribute werden in HTML-Kommentaren im Beitragsinhalt gespeichert. Daher sind sie nur beim Parsen des Blockinhalts zugänglich. Mit zusätzlichen Speicherorten kannst du:

  • Beiträge anhand von Feldwerten abfragen mit meta_query
  • Über REST API auf Werte zugreifen – für Headless-Setups
  • Daten mit anderen Plugins teilen, etwa SEO oder Caching-Plugins
  • Globale Einstellungen erstellen, die für alle Beiträge gelten

Speichertypen

Typ Speicherort Geltungsbereich Geeignet für
postMeta Tabelle wp_postmeta Pro Beitrag Abfragbare beitragsspezifische Daten
option Tabelle wp_options Global (gesamte Website) Website-Einstellungen, gemeinsame Werte

Hinweis

Blockattributspeicherung (im HTML-Kommentar des Beitragsinhalts) erfolgt immer automatisch. Die Eigenschaft storage fügt zusätzliche Speicherorte hinzu und ersetzt nicht die Speicherung im Block.

Konfiguration

Füge die Eigenschaft storage zu einer beliebigen Felddefinition hinzu:

JSON
{
  "name": "blockstudio/example",
  "title": "Example Block",
  "blockstudio": {
    "attributes": [
      {
        "id": "subtitle",
        "type": "text",
        "label": "Subtitle",
        "storage": {
          "type": "postMeta",
          "postMetaKey": "my_subtitle"
        }
      }
    ]
  }
}

Speichereigenschaften

Eigenschaft Typ Beschreibung
type string | string[] Zusätzlicher Speicherlocation(s): "postMeta", "option"
postMetaKey string Benutzerdefinierter Meta-Schlüssel (Standard: {block_name}_{field_id})
optionKey string Benutzerdefinierter Optionsschlüssel (Standard: {block_name}_{field_id})

Einzelner oder mehrfacher Speicher

JSON
// Add post meta storage
"storage": {
  "type": "postMeta"
}

// Add both post meta and option storage
"storage": {
  "type": ["postMeta", "option"]
}

So funktioniert es

  1. Registrierung: Wenn WordPress geladen wird, registriert Blockstudio Meta-Schlüssel und Einstellungen anhand deiner Feldkonfigurationen
  2. Bearbeitung: Werte werden im Editor als Blockattribute verwaltet (und immer im Block gespeichert)
  3. Speichern: Beitragsmetadaten werden beim Speichern des Beitrags synchronisiert. Website-Optionen werden synchronisiert, wenn der Beitrag veröffentlicht wird oder sich der Feldwert eines veröffentlichten Beitrags ändert.

Autospeicherungen und Revisionen synchronisieren keinen der beiden Speicherorte. Entwürfe, ausstehende, private und geplante Beiträge können ihre eigenen Beitragsmetadaten aktualisieren, ändern aber keine aktiven Website-Optionen. Bei einem geplanten Beitrag werden die Optionen synchronisiert, wenn WordPress ihn veröffentlicht.

Werte werden wortgetreu kopiert, einschließlich Backslashes, Anführungszeichen und verschachtelter Repeater-Werte. Füge Feldwerten kein Escaping hinzu, um die Meta-Speicherung von WordPress auszugleichen; Blockstudio behandelt diese Grenze. Website-Optionen behalten dieselben wortgetreuen Werte ohne zusätzliches Escaping bei.

Falls eine frühere Version Backslashes aus der Meta-Kopie eines Beitrags entfernt hat, speichere den Beitrag nach dem Upgrade erneut. Der ursprüngliche Feldwert in den Blockattributen wird verwendet, um die Meta-Kopie zu aktualisieren.

Website-Optionen speichern

Optionen gelten für die gesamte Website. Beim Veröffentlichen eines neuen Blocks werden die Optionsfelder gespeichert, die in seinen gespeicherten Attributen enthalten sind. Bei späteren Speicherungen wird jedes Feld mit der zuvor gespeicherten Version dieses Blocks verglichen, und nur geänderte Werte werden geschrieben. Das Speichern des Beitragstitels oder einer unveränderten älteren Blockkopie in einem anderen Beitrag überschreibt keinen neueren Optionswert.

Fehlt ein Feld in den gespeicherten Attributen, bleibt seine Option unverändert. Dadurch bleiben bestehende Optionen auch dann erhalten, wenn block.json ein neues Feld hinzugefügt wird. Ein explizites null löscht eine Option; leere Zeichenfolgen, false, 0 und leere Arrays werden als Werte gespeichert. Beim Entfernen eines Blocks werden seine Optionen nicht gelöscht.

Verwende einen festgelegten veröffentlichten Block, um jede gemeinsame Option zu verwalten. Wenn mehrere Blöcke dieselbe Option gezielt ändern, gilt der zuletzt gespeicherte geänderte Wert. Die Speicherung lädt den aktuellen Optionswert nicht in jeden Block: Jeder Block behält seine eigenen Feldwerte im Beitragsinhalt.

Bei dateibasierten Seiten ermöglicht ein persistenter Block key Blockstudio, denselben Block nach dem Verschieben im Dokument wiederzuerkennen. Blöcke ohne Schlüssel werden anhand ihres Namens und ihrer Position zugeordnet.

Auf gespeicherte Werte zugreifen

In Blockvorlagen

In deiner Blockvorlage sind Feldwerte immer über $attributes verfügbar:

PHP

PHP
<div>
  <h1><?php echo $a['subtitle']; ?></h1>
</div>

Twig

Twig
<div>
  <h1>{{ a.subtitle }}</h1>
</div>

Beitragsmetadaten (außerhalb des Blockkontexts)

Werte in postMeta sind überall in WordPress zugänglich:

PHP

PHP
// Get meta value
$subtitle = get_post_meta( $post_id, 'my_subtitle', true );

// Query posts by meta value
$posts = get_posts([
  'meta_key'   => 'my_subtitle',
  'meta_value' => 'Hello World',
]);

Twig

Twig
{# Using Timber #}
{{ post.meta('my_subtitle') }}

{# Or via function #}
{{ function('get_post_meta', post.id, 'my_subtitle', true) }}

Beitragsmetadaten sind auch über REST API verfügbar:

Shell
GET /wp-json/wp/v2/posts/123
# Response includes: { "meta": { "my_subtitle": "Hello World" } }

Optionen (globale Werte)

Werte in option sind auf der gesamten Website zugänglich:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

Twig
{{ function('get_option', 'site_company_name') }}

Beispiele

SEO-Meta-Felder

Speichere SEO-Daten in Beitragsmetadaten, um Kompatibilität mit SEO-Plugins herzustellen:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "seo_title",
        "type": "text",
        "label": "SEO Title",
        "storage": {
          "type": "postMeta",
          "postMetaKey": "_yoast_wpseo_title"
        }
      },
      {
        "id": "seo_description",
        "type": "textarea",
        "label": "Meta Description",
        "storage": {
          "type": "postMeta",
          "postMetaKey": "_yoast_wpseo_metadesc"
        }
      }
    ]
  }
}

Füge die Speicherung in Beitragsmetadaten hinzu, damit du Beiträge anhand von Feldwerten abfragen kannst:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "featured",
        "type": "toggle",
        "label": "Featured",
        "storage": {
          "type": "postMeta",
          "postMetaKey": "is_featured"
        }
      }
    ]
  }
}

Hervorgehobene Beiträge abfragen:

PHP
$featured_posts = get_posts([
  'meta_key'   => 'is_featured',
  'meta_value' => '1',
]);

Globale Website-Einstellungen

Speichere die websiteweite Konfiguration in Optionen:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "company_name",
        "type": "text",
        "label": "Company Name",
        "storage": {
          "type": "option",
          "optionKey": "site_company_name"
        }
      },
      {
        "id": "support_email",
        "type": "text",
        "label": "Support Email",
        "storage": {
          "type": "option",
          "optionKey": "site_support_email"
        }
      }
    ]
  }
}

Greife überall auf deiner Website darauf zu:

PHP
<footer>
  <p>&copy; <?php echo get_option( 'site_company_name' ); ?></p>
  <p>Contact: <?php echo get_option( 'site_support_email' ); ?></p>
</footer>

Beitragsmetadaten und Option

Für Daten, die sowohl auf Beitragsebene als auch global zugänglich sein müssen:

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "important_value",
        "type": "text",
        "label": "Important Value",
        "storage": {
          "type": ["postMeta", "option"],
          "postMetaKey": "important_meta",
          "optionKey": "important_option"
        }
      }
    ]
  }
}

Standardschlüsselnamen

Wenn du keinen benutzerdefinierten Schlüssel angibst, generiert Blockstudio automatisch einen:

Speichertyp Standardschlüsselformat Beispiel
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Der Blockname wird bereinigt (Schrägstriche werden durch Unterstriche ersetzt).

Warnung

Für den produktiven Einsatz werden benutzerdefinierte Schlüssel empfohlen. Standardschlüssel können sich ändern, wenn du deinen Block umbenennst.