Gå til indhold

Lagring

Som standard gemmes alle feltværdier som blokattributter i blokkommentaren i indlægsindholdet. Med lagringsfunktionen kan du også gemme værdier i indlægsmeta (wp_postmeta) eller indstillinger (wp_options), så de kan tilgås uden for blokkens kontekst.

Hvorfor bruge lagring?

Blokattributter gemmes i HTML-kommentarer i indlægsindholdet, hvilket betyder, at de kun er tilgængelige, når blokindholdet fortolkes. Ved at bruge yderligere lagringssteder kan du:

  • Forespørge indlæg ud fra feltværdier med meta_query
  • Tilgå værdier via REST API i headless-opsætninger
  • Dele data med andre plugins som SEO eller cacheplugins
  • Oprette globale indstillinger, der gælder på tværs af indlæg

Lagringstyper

Type Placering Omfang Bedst egnet til
postMeta tabellen wp_postmeta Pr. indlæg Data om enkelte indlæg, der kan forespørges på
option tabellen wp_options Globalt (hele webstedet) Webstedsindstillinger, delte værdier

Bemærk

Lagring af blokattributter (i HTML-kommentaren i indlægsindholdet) sker altid automatisk. Egenskaben storage tilføjer yderligere lagringssteder – den erstatter ikke bloklagring.

Konfiguration

Føj egenskaben storage til enhver feltdefinition:

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

Lagringsegenskaber

Egenskab Type Beskrivelse
type string | string[] Yderligere lagringslocation(s): "postMeta", "option"
postMetaKey string Brugerdefineret metanøgle (standard: {block_name}_{field_id})
optionKey string Brugerdefineret indstillingsnøgle (standard: {block_name}_{field_id})

Enkelt eller flere lagringssteder

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

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

Sådan fungerer det

  1. Registrering: Når WordPress indlæses, registrerer Blockstudio metanøgler og indstillinger baseret på dine feltkonfigurationer
  2. Redigering: Værdier håndteres som blokattributter i editoren (gemmes altid i blokken)
  3. Gemning: Indlægsmeta synkroniseres, når indlægget gemmes. Webstedsindstillinger synkroniseres, når indlægget udgives, eller når feltværdien i et udgivet indlæg ændres.

Automatiske gemninger og revisioner synkroniserer ingen af lagringsstederne. Kladder, indlæg, der afventer godkendelse, private indlæg og planlagte indlæg kan opdatere deres egen indlægsmeta, men ændrer ikke webstedets aktive indstillinger. Et planlagt indlæg synkroniserer indstillingerne, når WordPress udgiver det.

Værdier kopieres ordret, inklusive omvendte skråstreger, anførselstegn og indlejrede repeater-værdier. Tilføj ikke escaping til feltværdier for at kompensere for WordPress-metadatalagring; Blockstudio håndterer denne grænse. Webstedets indstillinger bevarer de samme ordrette værdier uden yderligere escaping.

Hvis en tidligere version fjernede omvendte skråstreger fra et indlægs metadatakopi, skal du gemme indlægget igen efter opgraderingen. Den oprindelige feltværdi i blokkens attributter bruges til at opdatere metadatakopien.

Gemning af webstedsindstillinger

Indstillinger deles på hele webstedet. Når en ny blok udgives, gemmes de indstillingsfelter, der er angivet i dens gemte attributter. Ved senere gemninger sammenlignes hvert felt med blokkens tidligere gemte version, og kun ændrede værdier gemmes. Når du gemmer et indlægs titel eller en uændret ældre kopi af blokken i et andet indlæg, overskrives en nyere indstillingsværdi ikke.

Et felt, der mangler i de gemte attributter, lader indstillingen være urørt. Det beskytter også eksisterende indstillinger, når der tilføjes et nyt felt i block.json. En udtrykkelig null sletter en indstilling; tomme strenge, false, 0 og tomme arrays gemmes som værdier. Når en blok fjernes, slettes dens indstillinger ikke.

Brug én udpeget udgivet blok til at administrere hver delt indstilling. Hvis flere blokke bevidst ændrer den samme indstilling, vinder den sidst ændrede værdi, der gemmes. Lagringen indlæser ikke den aktuelle indstilling i hver blok: Hver blok bevarer sine egne feltværdier i indholdet af indlægget.

På filbaserede sider gør en vedvarende blok key det muligt for Blockstudio at genkende den samme blok, efter at den er flyttet i dokumentet. Blokke uden en nøgle matches efter bloknavn og placering.

Adgang til gemte værdier

I blokskabeloner

I din blokskabelon er feltværdier altid tilgængelige via $attributes:

PHP

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

Twig

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

Indlægsmetadata (uden for blokindhold)

Værdier gemt i postMeta kan tilgås overalt i WordPress:

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) }}

Indlægsmetadata er også tilgængelige via REST API:

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

Indstillinger (globale værdier)

Værdier gemt i option er tilgængelige på hele webstedet:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Eksempler

SEO-metadatafelter

Gem SEO-data i indlægsmetadata for kompatibilitet med SEO-plugins:

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"
        }
      }
    ]
  }
}

Tilføj lagring af indlægsmetadata for at gøre det muligt at forespørge efter indlæg baseret på feltværdi:

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

Forespørg efter fremhævede indlæg:

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

Globale webstedsindstillinger

Gem konfiguration for hele webstedet i indstillinger:

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"
        }
      }
    ]
  }
}

Få adgang overalt på dit websted:

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

Indlægsmetadata og indstilling

Til data, der skal være tilgængelige både på indlægsniveau og globalt:

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

Standardnøglenavne

Når du ikke angiver en tilpasset nøgle, genererer Blockstudio automatisk en:

Lagertype Standardformat for nøgle Eksempel
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Bloknavnet renses (skråstreger erstattes med understregninger).

Advarsel

Tilpassede nøgler anbefales til produktionsbrug. Standardnøgler kan ændres, hvis du omdøber din blok.