Siirry sisältöön

Tallennus

Oletuksena kaikki kenttäarvot tallennetaan lohkomääritteiksi artikkelisisällön lohkokommenttiin. Tallennustoiminnolla voit tallentaa arvoja lisäksi artikkelin metatietoihin (wp_postmeta) tai asetuksiin (wp_options), jolloin niitä voi käyttää lohkon kontekstin ulkopuolella.

Miksi tallennusta kannattaa käyttää?

Lohkomääritteet tallennetaan artikkelisisällön HTML-kommenttien sisään, joten niihin pääsee käsiksi vain lohkosisältöä jäsentämällä. Muita tallennussijainteja käyttämällä voit:

  • Hakea artikkeleita kenttäarvojen perusteella kohteen meta_query avulla
  • Käyttää arvoja kohteen REST API kautta headless-asennuksissa
  • Jakaa dataa muiden lisäosien kanssa, kuten SEOn tai välimuistilisäosien
  • Luoda yleisiä asetuksia, jotka säilyvät artikkeleiden välillä

Tallennustyypit

Tyyppi Sijainti Laajuus Sopii parhaiten
postMeta wp_postmeta-taulu Artikkelikohtainen Haettavat artikkelikohtaiset tiedot
option wp_options-taulu Yleinen (koko sivustolla) Sivuston asetukset, jaetut arvot

Huomautus

Lohkomääritteet tallennetaan aina automaattisesti (artikkelisisällön HTML-kommenttiin). Ominaisuus storage lisää uusia tallennussijainteja, mutta ei korvaa lohkotallennusta.

Määritykset

Lisää ominaisuus storage mihin tahansa kenttämäärittelyyn:

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

Tallennusominaisuudet

Ominaisuus Tyyppi Kuvaus
type string | string[] Lisätallennuksen location(s): "postMeta", "option"
postMetaKey string Mukautettu meta-avain (oletus: {block_name}_{field_id})
optionKey string Mukautettu asetusavain (oletus: {block_name}_{field_id})

Yksi vai useita tallennussijainteja

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

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

Näin se toimii

  1. Rekisteröinti: Kun WordPress latautuu, Blockstudio rekisteröi meta-avaimet ja asetukset kenttämääritysten perusteella
  2. Muokkaus: Arvoja hallitaan editorissa lohkomääritteinä (ne tallennetaan aina lohkoon)
  3. Tallennus: Artikkelin metatiedot synkronoidaan, kun artikkeli tallennetaan. Sivuston asetukset synkronoidaan, kun artikkeli julkaistaan tai julkaistun artikkelin kenttäarvo muuttuu.

Automaattitallennukset ja versiot eivät synkronoi kumpaakaan tallennussijaintia. Luonnos-, odottavat, yksityiset ja ajastetut artikkelit voivat päivittää omia artikkelikohtaisia metatietojaan, mutta ne eivät muuta sivuston aktiivisia asetuksia. Ajastettu artikkeli synkronoi asetukset, kun WordPress julkaisee sen.

Arvot kopioidaan sellaisinaan, mukaan lukien kenoviivat, lainausmerkit ja sisäkkäiset toistinkenttien arvot. Älä lisää kenttäarvoihin escapetusta kompensoidaksesi tunnisteen WordPress metatietojen tallennusta; Blockstudio käsittelee tämän rajan. Sivuston asetukset säilyttävät samat arvot sellaisinaan ilman ylimääräistä kenoviivojen lisäämistä.

Jos aiempi versio poisti kenoviivoja artikkelin metatietojen kopiosta, tallenna artikkeli uudelleen päivityksen jälkeen. Lohkon määritteissä olevaa alkuperäistä kenttäarvoa käytetään metatietokopion päivittämiseen.

Sivuston asetusten tallentaminen

Asetukset ovat yhteisiä koko sivustolla. Uuden lohkon julkaiseminen tallentaa sen tallennetuissa määritteissä annetut asetusarvot. Myöhemmissä tallennuksissa kutakin kenttää verrataan lohkon edelliseen tallennettuun versioon, ja vain muuttuneet arvot tallennetaan. Artikkelin otsikon tallentaminen tai muuttumattoman, vanhemman lohkokopion tallentaminen toisessa artikkelissa ei korvaa uudempaa asetusarvoa.

Tallennetuista määritteistä puuttuva kenttä jättää sen asetuksen ennalleen. Tämä suojaa olemassa olevia asetuksia myös silloin, kun kohtaan block.json lisätään uusi kenttä. Nimenomainen null poistaa asetuksen; tyhjät merkkijonot, false, 0 ja tyhjät taulukot tallennetaan arvoina. Lohkon poistaminen ei poista sen asetuksia.

Käytä yhtä nimettyä julkaistua lohkoa kunkin yhteisen asetuksen hallintaan. Jos useat lohkot muuttavat tarkoituksella samaa asetusta, viimeksi muutettu ja tallennettu arvo jää voimaan. Tallennus ei lataa nykyistä asetusta jokaiseen lohkoon: kukin lohko säilyttää omat kenttäarvonsa artikkelin sisällössä.

Tiedostopohjaisilla sivuilla pysyvä lohkon key auttaa Blockstudio-toimintoa tunnistamaan saman lohkon, vaikka se siirtyisi asiakirjassa. Avaimettomat lohkot täsmäytetään lohkon nimen ja sijainnin perusteella.

Tallennettujen arvojen käyttäminen

Lohkomalleissa

Lohkomallissasi kenttien arvot ovat aina käytettävissä tämän kautta: $attributes:

PHP

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

Twig

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

Artikkelin metatiedot (lohkokontekstin ulkopuolella)

Kohtaan postMeta tallennettuja arvoja voi käyttää missä tahansa kohteessa 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) }}

Artikkelin metatiedot ovat käytettävissä myös tämän kautta: REST API:

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

Asetukset (yleiset arvot)

Kohtaan option tallennetut arvot ovat käytettävissä koko sivustolla:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Esimerkkejä

SEO-metatietokentät

Tallenna SEO-tiedot artikkelin metatietoihin yhteensopivuutta varten seuraavien kanssa: SEO-lisäosat:

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

Lisää artikkelin metatietojen tallennus, jotta voit hakea artikkeleita kentän arvon perusteella:

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

Hae nostatetut artikkelit:

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

Sivuston yleiset asetukset

Tallenna koko sivustoa koskevat määritykset asetuksiin:

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

Käytä niitä missä tahansa sivustollasi:

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

Artikkelin metatiedot ja asetus

Tiedoille, joiden on oltava käytettävissä sekä artikkelitasolla että yleisesti:

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

Oletusavainten nimet

Kun et määritä omaa avainta, Blockstudio luo sen automaattisesti:

Tallennustyyppi Oletusavaimen muoto Esimerkki
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Lohkon nimi siistitään (vinoviivat korvataan alaviivoilla).

Varoitus

Omia avaimia suositellaan tuotantokäyttöön. Oletusavaimet voivat muuttua, jos nimeät lohkosi uudelleen.