Hoppa till innehåll

Lagring

Som standard lagras alla fältvärden som blockattribut i blockkommentaren i inläggsinnehållet. Med lagringsfunktionen kan du dessutom lagra värden i inläggsmetadata (wp_postmeta) eller alternativ (wp_options), så att de blir tillgängliga utanför blockets sammanhang.

Varför använda lagring?

Blockattribut lagras i HTML-kommentarer i inläggsinnehållet, vilket innebär att de bara är tillgängliga när blockinnehåll tolkas. Med ytterligare lagringsplatser kan du:

  • Söka efter inlägg med fältvärden med meta_query
  • Komma åt värden via REST API i huvudlösa lösningar
  • Dela data med andra tillägg, till exempel SEO eller cachetillägg
  • Skapa globala inställningar som gäller för flera inlägg

Lagringstyper

Typ Plats Omfattning Passar bäst för
postMeta tabell wp_postmeta Per inlägg Sökbara data som gäller ett visst inlägg
option tabell wp_options Global (hela webbplatsen) Webbplatsinställningar, delade värden

Obs

Lagring av blockattribut (i kommentaren HTML i inläggsinnehållet) sker alltid automatiskt. Egenskapen storage lägger till ytterligare lagringsplatser – den ersätter inte blocklagringen.

Konfiguration

Lägg till egenskapen storage i valfri fältdefinition:

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

Lagringsegenskaper

Egenskap Typ Beskrivning
type string | string[] Ytterligare lagringslocation(s): "postMeta", "option"
postMetaKey string Anpassad metanyckel (standard: {block_name}_{field_id})
optionKey string Anpassad alternativnyckel (standard: {block_name}_{field_id})

Enskild eller flera lagringsplatser

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

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

Så fungerar det

  1. Registrering: När WordPress läses in registrerar Blockstudio metanycklar och inställningar utifrån dina fältkonfigurationer
  2. Redigering: Värden hanteras som blockattribut i redigeraren (lagras alltid i blocket)
  3. Sparande: Inläggsmetadata synkroniseras när inlägget sparas. Webbplatsalternativ synkroniseras när inlägget publiceras eller när fältvärdet i ett publicerat inlägg ändras.

Autosparningar och versioner synkroniserar inte heller någon av lagringsplatserna. Utkast, väntande, privata och schemalagda inlägg kan uppdatera sin egen inläggsmetadata, men ändrar inte aktiva webbplatsalternativ. Ett schemalagt inlägg synkroniserar alternativen när WordPress publicerar det.

Värden kopieras ordagrant, inklusive omvänt snedstreck, citattecken och nästlade repeater-värden. Lägg inte till escapning i fältvärden för att kompensera för WordPress-metadatalagring; Blockstudio hanterar den gränsen. Webbplatsalternativ behåller samma ordagranna värden utan ytterligare snedstreck.

Om en tidigare version tog bort omvända snedstreck från ett inläggs metakopia, spara inlägget igen efter uppgraderingen. Det ursprungliga fältvärdet i dess blockattribut används för att uppdatera metakopian.

Spara webbplatsalternativ

Alternativ delas på hela webbplatsen. När ett nytt block publiceras skrivs de alternativfält som anges i dess sparade attribut. Vid senare sparningar jämförs varje fält med föregående sparade version av blocket, och endast ändrade värden skrivs. När ett inläggs titel sparas, eller när en oförändrad äldre kopia av blocket på ett annat inlägg sparas, skrivs inte ett nyare alternativvärde över.

Ett fält som utelämnas från de sparade attributen lämnar dess alternativ orört. Detta skyddar också befintliga alternativ när ett nytt fält läggs till i block.json. En uttrycklig null raderar ett alternativ; tomma strängar, false, 0 och tomma arrayer sparas som värden. Om ett block tas bort raderas inte dess alternativ.

Använd ett utsett publicerat block för att hantera varje delat alternativ. Om flera block avsiktligt ändrar samma alternativ sparas det senast ändrade värdet. Lagringen läser inte in det aktuella alternativet i varje block: varje block behåller sina egna fältvärden i inläggets innehåll.

För filbaserade sidor gör ett beständigt block key att Blockstudio känner igen samma block även efter att det flyttats i dokumentet. Block utan nyckel matchas efter blocknamn och position.

Åtkomst till lagrade värden

I blockmallar

I blockmallen är fältvärden alltid tillgängliga via $attributes:

PHP

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

Twig

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

Inläggsmetadata (utanför blockkontexten)

Värden som lagras i postMeta kan nås var som helst 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) }}

Inläggsmetadata är också tillgänglig via REST API:

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

Alternativ (globala värden)

Värden som lagras i option är tillgängliga på hela webbplatsen:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Exempel

SEO-metafält

Lagra SEO-data i inläggsmetadata för kompatibilitet med tillägg för SEO:

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

Lägg till lagring av inläggsmetadata för att kunna söka efter inlägg utifrån fältvärde:

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

Sök efter utvalda inlägg:

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

Globala webbplatsinställningar

Lagra konfiguration för hela webbplatsen i alternativ:

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

Åtkomst var som helst på webbplatsen:

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

Inläggsmetadata och alternativ

För data som behöver vara tillgängliga både på inläggsnivå och globalt:

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

Standardnyckelnamn

Om du inte anger en anpassad nyckel genererar Blockstudio en automatiskt:

Lagringstyp Format för standardnyckel Exempel
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Blocknamnet saneras (snedstreck ersätts med understreck).

Varning

Anpassade nycklar rekommenderas för produktionsbruk. Standardnycklar kan ändras om du byter namn på blocket.