Preskoči na vsebino

Shranjevanje

Privzeto so vse vrednosti polj shranjene kot atributi blokov v komentarju bloka v vsebini objave. Funkcija shranjevanja omogoča, da vrednosti dodatno shranite v metapodatke objave (wp_postmeta) ali možnosti (wp_options), tako da so dostopne tudi zunaj konteksta bloka.

Zakaj uporabiti shranjevanje?

Atributi blokov so shranjeni v komentarjih HTML v vsebini objave, zato so dostopni samo pri razčlenjevanju vsebine bloka. Z dodatnimi mesti za shranjevanje lahko:

  • Poizvedujete po objavah glede na vrednosti polj z uporabo meta_query
  • Dostopate do vrednosti prek REST API pri brezglavih postavitvah
  • Delite podatke z drugimi vtičniki, kot je SEO, ali z vtičniki za predpomnjenje
  • Ustvarite globalne nastavitve, ki se ohranijo med objavami

Vrste shranjevanja

Vrsta Mesto Obseg Primerno za
postMeta tabela wp_postmeta Posamezna objava Podatki, specifični za objavo, po katerih je mogoče poizvedovati
option tabela wp_options Globalno (za celotno spletno mesto) Nastavitve spletnega mesta, skupne vrednosti

Opomba

Shranjevanje atributov blokov (v komentarju HTML v vsebini objave) poteka vedno samodejno. Lastnost storage doda dodatna mesta za shranjevanje – ne nadomesti shranjevanja v bloku.

Konfiguracija

Lastnost storage dodajte kateri koli definiciji polja:

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

Lastnosti shranjevanja

Lastnost Vrsta Opis
type string | string[] Dodatni location(s) za shranjevanje: "postMeta", "option"
postMetaKey string Lastni ključ metapodatkov (privzeto: {block_name}_{field_id})
optionKey string Lastni ključ možnosti (privzeto: {block_name}_{field_id})

Eno ali več mest za shranjevanje

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

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

Kako deluje

  1. Registracija: Ko se naloži WordPress, Blockstudio registrira ključe metapodatkov in nastavitve glede na konfiguracije vaših polj
  2. Urejanje: Vrednosti se upravljajo kot atributi blokov v urejevalniku (vedno so shranjene v bloku)
  3. Shranjevanje: Metapodatki objave se sinhronizirajo ob shranjevanju objave. Možnosti spletnega mesta se sinhronizirajo ob objavi ali spremembi vrednosti polja v objavljeni objavi.

Samodejno shranjene različice in revizije ne sinhronizirajo nobenega od mest za shranjevanje. Osnutki, čakajoče, zasebne in načrtovane objave lahko posodobijo lastne metapodatke objave, vendar ne spreminjajo možnosti spletnega mesta v živo. Načrtovana objava sinhronizira možnosti, ko jo objavi WordPress.

Vrednosti se kopirajo dobesedno, vključno s poševnicami nazaj, narekovaji in vrednostmi ugnezdenih ponavljalnikov. Vrednosti polj ne ubežite, da bi nadomestili shranjevanje meta podatkov prek WordPress; za to mejo poskrbi Blockstudio. Možnosti spletnega mesta ohranijo enake dobesedne vrednosti brez dodatnega dodajanja poševnic.

Če je prejšnja različica iz kopije meta podatkov objave odstranila poševnice nazaj, po nadgradnji objavo znova shranite. Za osvežitev kopije meta podatkov se uporabi izvirna vrednost polja v atributih bloka.

Shranjevanje možnosti spletnega mesta

Možnosti so skupne celotnemu spletnemu mestu. Objava novega bloka zapiše polja možnosti, podana v njegovih shranjenih atributih. Poznejša shranjevanja primerjajo vsako polje s prejšnjo shranjeno različico tega bloka in zapišejo samo spremenjene vrednosti. Shranjevanje naslova objave ali nespremenjene starejše kopije bloka v drugi objavi ne prepiše novejše vrednosti možnosti.

Če polje izpustite iz shranjenih atributov, njegova možnost ostane nespremenjena. To zaščiti tudi obstoječe možnosti, ko v block.json dodate novo polje. Izrecni null izbriše možnost; prazni nizi, false, 0 in prazna polja se shranijo kot vrednosti. Odstranitev bloka ne izbriše njegovih možnosti.

Za upravljanje vsake možnosti v skupni rabi določite en objavljen blok. Če več blokov namenoma spremeni isto možnost, zmaga nazadnje shranjena spremenjena vrednost. Shramba ne naloži trenutne možnosti v vsak blok: vsak blok ohrani svoje vrednosti polj v vsebini objave.

Pri straneh, ki temeljijo na datotekah, trajni blok key omogoča, da Blockstudio prepozna isti blok tudi po tem, ko ga premaknete v dokumentu. Bloki brez ključa se ujemajo po imenu bloka in položaju.

Dostop do shranjenih vrednosti

V predlogah blokov

V predlogi bloka so vrednosti polj vedno na voljo prek $attributes:

PHP

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

Twig

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

Metapodatki objave (zunaj konteksta bloka)

Do vrednosti, shranjenih v postMeta, lahko dostopate kjer koli v 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) }}

Metapodatki objave so na voljo tudi prek REST API:

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

Možnosti (globalne vrednosti)

Vrednosti, shranjene v option, so dostopne na celotnem spletnem mestu:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Primeri

Metapodatkovna polja SEO

Podatke SEO shranite v metapodatke objave zaradi združljivosti z vtičniki 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"
        }
      }
    ]
  }
}

Dodajte shranjevanje metapodatkov objave, da boste lahko iskali objave po vrednosti polja:

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

Poiščite izpostavljene objave:

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

Globalne nastavitve spletnega mesta

Konfiguracijo za celotno spletno mesto shranite v možnosti:

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

Dostopajte do njih kjer koli na svojem spletnem mestu:

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

Metapodatki objave in možnost

Za podatke, ki morajo biti dostopni tako na ravni objave kot globalno:

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

Privzeta imena ključev

Če ne določite ključa po meri, Blockstudio samodejno ustvari ključ:

Vrsta shrambe Oblika privzetega ključa Primer
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Ime bloka se normalizira (poševnice se zamenjajo s podčrtaji).

Opozorilo

Za uporabo v produkciji priporočamo ključe po meri. Privzeti ključi se lahko spremenijo, če preimenujete blok.