Liigu sisu juurde

Salvestamine

Vaikimisi salvestatakse kõik väljade väärtused ploki atribuutidena postituse sisu plokikommentaaris. Salvestusfunktsioon võimaldab lisaks salvestada väärtusi postituse metaandmetesse (wp_postmeta) või suvanditesse (wp_options), et need oleksid kättesaadavad ka väljaspool ploki konteksti.

Miks salvestusfunktsiooni kasutada?

Ploki atribuudid salvestatakse postituse sisu HTML kommentaarides, mis tähendab, et need on kättesaadavad ainult ploki sisu parsimisel. Täiendavaid salvestuskohti kasutades saate:

  • Pärida postitusi väljaväärtuste järgi funktsiooniga meta_query
  • Juurdepääs väärtustele funktsiooni REST API kaudu peata seadistustes
  • Jagada andmeid teiste pluginate, näiteks SEO või vahemälulisanditega
  • Luua globaalseid seadistusi, mis säilivad postituste vahel

Salvestustüübid

Tüüp Asukoht Ulatus Sobib kõige paremini
postMeta tabel wp_postmeta Postitusepõhine Päringutega leitavad postituspõhised andmed
option tabel wp_options Globaalne (kogu saidil) Saidi seaded, jagatud väärtused

Märkus

Ploki atribuudid salvestatakse alati automaatselt (postituse sisu kommentaari HTML). Atribuut storage lisab täiendavad salvestuskohad ega asenda ploki salvestuskohta.

Konfiguratsioon

Lisage atribuut storage mis tahes välja määratlusse:

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

Salvestusatribuudid

Atribuut Tüüp Kirjeldus
type string | string[] Täiendavad salvestuskohad location(s): "postMeta", "option"
postMetaKey string Kohandatud metaandmete võti (vaikimisi: {block_name}_{field_id})
optionKey string Kohandatud suvandi võti (vaikimisi: {block_name}_{field_id})

Üks salvestuskoht või mitu

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

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

Kuidas see töötab

  1. Registreerimine: kui WordPress laaditakse, registreerib Blockstudio meta-võtmed ja seaded teie väljade konfiguratsiooni põhjal
  2. Redigeerimine: väärtusi hallatakse redaktoris ploki atribuutidena (salvestatakse alati plokki)
  3. Salvestamine: postituse salvestamisel sünkroonitakse postituse metaandmed. Saidi valikud sünkroonitakse postituse avaldamisel või avaldatud postituse välja väärtuse muutmisel.

Automaatseid salvestusi ja versioone ei sünkroonita kummaski salvestuskohas. Mustand-, ootel, privaatsed ja ajastatud postitused saavad uuendada enda postituse metaandmeid, kuid ei muuda saidi aktiivseid suvandeid. Ajastatud postitus sünkroonib suvandid, kui WordPress selle avaldab.

Väärtused kopeeritakse sõna-sõnalt, sealhulgas kaldkriipsud, jutumärgid ja pesastatud kordaja väärtused. Ärge lisage välja väärtustele paomärke, et kompenseerida WordPress metaandmete salvestust; selle piiri eest hoolitseb Blockstudio. Saidi valikud säilitavad samad sõnasõnalised väärtused ilma täiendava kaldkriipsutamiseta.

Kui varasem versioon eemaldas postituse metaandmete koopiast kaldkriipsud, salvestage postitus pärast uuendamist uuesti. Metaandmete koopia värskendamiseks kasutatakse algset välja väärtust selle ploki atribuutides.

Saidi suvandite salvestamine

Valikud on jagatud kogu saidi ulatuses. Uue ploki avaldamisel kirjutatakse salvestatud atribuutides esitatud valikuväljad. Hilisemal salvestamisel võrreldakse iga välja ploki eelmise salvestatud versiooniga ja kirjutatakse ainult muudetud väärtused. Postituse pealkirja salvestamine või ploki muutmata vanema koopia salvestamine mõnel teisel postitusel ei kirjuta uuemat valikuväärtust üle.

Salvestatud atribuutidest välja jäetud väli jätab selle valiku muutmata. See kaitseb olemasolevaid valikuid ka siis, kui lisatakse uus väli üksusele block.json. Selgesõnaline null kustutab valiku; tühjad stringid, false, 0 ja tühjad massiivid salvestatakse väärtustena. Ploki eemaldamine selle valikuid ei kustuta.

Kasutage iga jagatud valiku haldamiseks üht kindlat avaldatud plokki. Kui mitu plokki muudavad teadlikult sama valikut, jääb kehtima viimasena muudetud ja salvestatud väärtus. Salvestus ei laadi kehtivat valikut igasse plokki: iga plokk säilitab oma välja väärtused postituse sisus.

Failipõhiste lehtede puhul võimaldab püsiv ploki key üksusel Blockstudio sama ploki ära tunda ka pärast selle teisaldamist dokumendis. Võtmeta plokid sobitatakse ploki nime ja asukoha järgi.

Salvestatud väärtustele juurdepääs

Plokimallides

Plokimallis on väljamuutujate väärtused alati saadaval järgmiselt: $attributes:

PHP

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

Twig

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

Postituse metaandmed (väljaspool ploki konteksti)

Üksusesse postMeta salvestatud väärtustele pääseb ligi kõikjal üksuses 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) }}

Postituse metaandmed on saadaval ka üksuse REST API kaudu:

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

Valikud (üldised väärtused)

Üksusesse option salvestatud väärtused on kättesaadavad kogu saidil:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Näited

SEO metaandmeväljad

Salvestage SEO andmed postituse metaandmetesse, et tagada ühilduvus SEO pluginate kanssa:

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

Lisage postituse metaandmete salvestus, et saaksite postitusi välja väärtuse järgi pärida:

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

Pärige esiletõstetud postitusi:

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

Saidiülesed seaded

Salvestage kogu saidi konfiguratsioon valikutesse:

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

Juurdepääs kõikjal saidil:

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

Postituse metaandmed ja valik

Andmete jaoks, millele peab olema juurdepääs nii postituse kui ka kogu saidi tasandil:

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

Vaikimisi võtmenimed

Kui te kohandatud võtit ei määra, loob Blockstudio selle automaatselt:

Salvestustüüp Vaikimisi võtmevorming Näide
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Ploki nimi puhastatakse (kaldkriipsud asendatakse alakriipsudega).

Hoiatus

Tootmiskeskkonnas on soovitatav kasutada kohandatud võtmeid. Vaikimisi võtmed võivad muutuda, kui nimetate ploki ümber.