Pereiti prie turinio

Saugojimas

Pagal numatytuosius nustatymus visos laukų reikšmės saugomos kaip bloko atributai komentare bloko viduje, esančiame įrašo turinyje. Saugojimo funkcija leidžia papildomai išsaugoti reikšmes įrašo meta duomenyse (wp_postmeta) arba parinktyse (wp_options), kad jas būtų galima pasiekti už bloko konteksto ribų.

Kodėl verta naudoti saugojimą?

Bloko atributai saugomi HTML komentaruose įrašo turinyje, todėl juos galima pasiekti tik analizuojant bloko turinį. Naudodami papildomas saugojimo vietas galite:

  • Vykdyti įrašų užklausas pagal laukų reikšmes naudojant meta_query
  • Pasiekti reikšmes per REST API sistemose be sąsajos
  • Dalytis duomenimis su kitais papildiniais, pavyzdžiui, SEO arba spartinančiosios atminties papildiniais
  • Kurti visuotinius nustatymus, kurie išlieka skirtinguose įrašuose

Saugojimo tipai

Tipas Vieta Taikymo sritis Tinka naudoti
postMeta wp_postmeta lentelė Vienam įrašui Užklausoms naudojami konkretaus įrašo duomenys
option wp_options lentelė Visai svetainei Svetainės nustatymai, bendrinamos reikšmės

Pastaba

Bloko atributai visada išsaugomi automatiškai (komentare HTML, įrašo turinyje). Savybė storage prideda papildomų saugojimo vietų, o ne pakeičia bloko saugojimą.

Konfigūracija

Pridėkite savybę storage prie bet kurio lauko aprašo:

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

Saugojimo savybės

Ypatybė Tipas Aprašymas
type string | string[] Papildoma saugykla location(s): "postMeta", "option"
postMetaKey string Pasirinktinis meta raktas (numatytasis: {block_name}_{field_id})
optionKey string Pasirinktinis parinkties raktas (numatytasis: {block_name}_{field_id})

Viena ar kelios saugojimo vietos

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

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

Kaip tai veikia

  1. Registravimas: įkėlus WordPress, Blockstudio užregistruoja meta raktus ir nustatymus pagal jūsų laukų konfigūraciją
  2. Redagavimas: reikšmės redaktoriuje tvarkomos kaip bloko atributai (visada išsaugomi bloke)
  3. Išsaugojimas: įrašo meta duomenys sinchronizuojami išsaugojus įrašą. Svetainės parinktys sinchronizuojamos paskelbus įrašą arba pasikeitus paskelbto įrašo lauko reikšmei.

Automatiškai išsaugomos versijos ir redakcijos nesinchronizuoja nė vienos saugojimo vietos. Juodraščiai, laukiantys patvirtinimo, privatūs ir suplanuoti įrašai gali atnaujinti savo meta duomenis, tačiau nekeičia svetainės veikiančių parinkčių. Suplanuotas įrašas sinchronizuoja parinktis, kai WordPress jį paskelbia.

Reikšmės kopijuojamos pažodžiui, įskaitant pasviruosius brūkšnius, kabutes ir įdėtų kartotuvo laukų reikšmes. Nedėkite į laukų reikšmes papildomų skyrybos ženklų, kad kompensuotumėte WordPress metaduomenų saugyklą; šią ribą tvarko Blockstudio. Svetainės parinktys išsaugo tas pačias pažodines reikšmes be papildomo skyrybos ženklų pridėjimo.

Jei ankstesnė versija pašalino pasviruosius brūkšnius iš įrašo metaduomenų kopijos, atnaujinę išsaugokite įrašą dar kartą. Metaduomenų kopija atnaujinama naudojant pradinę lauko reikšmę jo bloko atributuose.

Svetainės parinkčių išsaugojimas

Parinktys bendrinamos visoje svetainėje. Paskelbus naują bloką, išsaugotuose jo atributuose pateiktos laukų reikšmės įrašomos į parinktis. Vėliau išsaugant pakeitimai nustatomi palyginus kiekvieną lauką su ankstesne išsaugota to bloko versija, ir įrašomos tik pakitusios reikšmės. Išsaugojus įrašo pavadinimą arba nepakeistą senesnę bloko kopiją kitame įraše, naujesnė parinkties reikšmė neperrašoma.

Laukas, praleistas įrašomuose atributuose, palieka jo parinktį nepakeistą. Taip pat apsaugomos esamos parinktys, kai pridedamas naujas laukas prie block.json. Aiškiai nurodžius null, parinktis ištrinama; tuščios eilutės, false, 0 ir tušti masyvai išsaugomi kaip reikšmės. Pašalinus bloką, jo parinktys neištrinamos.

Kiekvienai bendrai parinkčiai valdyti naudokite vieną paskelbtą bloką. Jei keli blokai sąmoningai keičia tą pačią parinktį, išsaugoma paskutinė pakeista reikšmė. Saugykla neįkelia dabartinės parinkties į kiekvieną bloką: kiekvienas blokas išsaugo savo laukų reikšmes įrašo turinyje.

Puslapiuose, kurių turinys saugomas failuose, pastovus bloko key leidžia Blockstudio atpažinti tą patį bloką jam perkėlus dokumente. Blokai be rakto susiejami pagal bloko pavadinimą ir vietą.

Išsaugotų reikšmių pasiekimas

Blokų šablonuose

Bloko šablone laukų reikšmės visada pasiekiamos per $attributes:

PHP

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

Twig

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

Įrašo metaduomenys (už bloko konteksto ribų)

postMeta saugomas reikšmes galima pasiekti bet kurioje WordPress vietoje:

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

Įrašo metaduomenys taip pat pasiekiami per REST API:

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

Parinktys (visuotinės reikšmės)

option saugomos reikšmės pasiekiamos visoje svetainėje:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Pavyzdžiai

SEO metaduomenų laukai

Saugokite SEO duomenis įrašo metaduomenyse, kad jie būtų suderinami su SEO įskiepiais:

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

Pridėkite įrašo metaduomenų saugyklą, kad galėtumėte ieškoti įrašų pagal lauko reikšmę:

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

Užklauskite išskirtinių įrašų:

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

Visuotiniai svetainės nustatymai

Saugokite visos svetainės konfigūraciją parinktyse:

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

Pasiekite bet kurioje svetainės vietoje:

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

Įrašo metaduomenys ir parinktis

Duomenims, kuriuos reikia pasiekti ir įrašo, ir visuotinėje srityje:

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

Numatyti raktų pavadinimai

Jei nenurodote tinkinto rakto, Blockstudio jį sugeneruoja automatiškai:

Saugyklos tipas Numatytasis rakto formatas Pavyzdys
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Bloko pavadinimas išvalomas (pasvirieji brūkšniai pakeičiami pabraukimo brūkšniais).

Įspėjimas

Produkcinėje aplinkoje rekomenduojama naudoti tinkintus raktus. Pervadinus bloką, numatytieji raktai gali pasikeisti.