Ugrás a tartalomhoz

Tárolás

Alapértelmezés szerint minden mezőérték blokk-attribútumként tárolódik a bejegyzéstartalom blokkmegjegyzésében. A tárolási funkció lehetővé teszi az értékek további tárolását bejegyzés-metaadatokban (wp_postmeta) vagy beállításokban (wp_options), így azok a blokk környezetén kívül is elérhetők.

Miért használjon tárolást?

A blokk attribútumai a bejegyzés tartalmában lévő HTML megjegyzéseken belül tárolódnak, ezért csak a blokk tartalmának feldolgozásakor érhetők el. További tárolási helyek használatával a következőket teheti:

  • Bejegyzések lekérdezése mezőértékek szerint a meta_query használatával
  • Értékek elérése a REST API segítségével headless környezetekben
  • Adatok megosztása más bővítményekkel, például a SEO bővítménnyel vagy gyorsítótárazó bővítményekkel
  • Globális beállítások létrehozása, amelyek bejegyzések között is megmaradnak

Tárolási típusok

Típus Hely Hatókör Mire ajánlott
postMeta wp_postmeta tábla Bejegyzésenként Lekérdezhető, bejegyzésspecifikus adatok
option wp_options tábla Globális (az egész webhelyre) Webhelybeállítások, megosztott értékek

Megjegyzés

A blokk attribútumainak tárolása (a bejegyzés tartalmának HTML megjegyzésében) mindig automatikusan történik. A storage tulajdonság további tárolási helyeket ad hozzá, nem váltja ki a blokktárolást.

Konfiguráció

Adja hozzá a storage tulajdonságot bármely meződefinícióhoz:

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

Tárolási tulajdonságok

Tulajdonság Típus Leírás
type string | string[] További tárolási location(s): "postMeta", "option"
postMetaKey string Egyéni metaadatkulcs (alapértelmezés: {block_name}_{field_id})
optionKey string Egyéni beállításkulcs (alapértelmezés: {block_name}_{field_id})

Egy vagy több tárolási hely

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

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

Működés

  1. Regisztráció: A WordPress betöltésekor a Blockstudio regisztrálja a mezőkonfigurációk alapján a metaadatkulcsokat és a beállításokat
  2. Szerkesztés: Az értékeket a szerkesztő blokk-attribútumként kezeli (a blokkban mindig tárolódnak)
  3. Mentés: A bejegyzés mentésekor a bejegyzés-metaadatok szinkronizálódnak. A webhely beállításai a bejegyzés közzétételekor, illetve egy közzétett bejegyzés mezőértékének módosításakor szinkronizálódnak.

Az automatikus mentések és a változatok egyik tárolási helyet sem szinkronizálják. A piszkozatok, függőben lévő, privát és ütemezett bejegyzések frissíthetik saját bejegyzés-metaadataikat, de az élő webhely beállításait nem módosítják. Egy ütemezett bejegyzés akkor szinkronizálja a beállításokat, amikor a WordPress közzéteszi.

Az értékek szó szerint másolódnak, beleértve a fordított perjeleket, az idézőjeleket és a beágyazott ismétlő értékeket is. Ne adjon escape karaktereket a mezőértékekhez a WordPress metaadat-tárolás kompenzálására; ezt a határt a Blockstudio kezeli. A webhelybeállítások ugyanazokat a szó szerinti értékeket őrzik meg további perjelezés nélkül.

Ha egy korábbi verzió eltávolította a fordított perjeleket egy bejegyzés metaadat-másolatából, frissítés után mentse újra a bejegyzést. A metaadat-másolat frissítéséhez a blokk attribútumaiban tárolt eredeti mezőérték szolgál.

Webhelybeállítások mentése

A beállítások az egész webhelyen közösek. Egy új blokk közzététele a mentett attribútumaiban megadott mezőértékeket írja beállításként. A későbbi mentések összevetik az egyes mezőket a blokk korábban mentett változatával, és csak a módosult értékeket írják át. Egy bejegyzés címének mentése vagy a blokk egy másik bejegyzésben lévő, változatlan régebbi példánya nem írja felül az újabb beállításértéket.

Ha egy mező kimarad a mentett attribútumok közül, a hozzá tartozó beállítás változatlan marad. Ez az új mező hozzáadásakor a meglévő beállításokat is megóvja a block.json esetében. A kifejezetten megadott null töröl egy beállítást; az üres karakterláncok, a false, a 0 és az üres tömbök értékként kerülnek mentésre. Egy blokk eltávolítása nem törli a beállításait.

Minden közös beállítást egy kijelölt, közzétett blokkal kezeljen. Ha több blokk szándékosan módosítja ugyanazt a beállítást, az utolsóként mentett módosított érték marad érvényben. A tárolás nem tölti be az aktuális beállításértéket minden blokkba: mindegyik blokk a saját mezőértékeit őrzi a bejegyzés tartalmában.

Fájlból kezelt oldalak esetén egy tartós blokk-key lehetővé teszi, hogy a Blockstudio felismerje ugyanazt a blokkot, miután az máshová került a dokumentumban. A kulcs nélküli blokkok egyezését a rendszer a blokk neve és pozíciója alapján állapítja meg.

Tárolt értékek elérése

Blokksablonokban

A blokksablonban a mezőértékek mindig elérhetők a következőn keresztül: $attributes:

PHP

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

Twig

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

Bejegyzésmeta (a blokk kontextusán kívül)

A postMeta tárolt értékei bárhol elérhetők a WordPress rendszerben:

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

A bejegyzésmeta is elérhető a következőn keresztül: REST API:

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

Beállítások (globális értékek)

A option tárolt értékei a webhely egészén elérhetők:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Példák

SEO metaadatmezők

A SEO adatainak tárolása bejegyzésmetában, a SEO bővítményekkel való kompatibilitás érdekében:

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

Adjon hozzá bejegyzésmeta-tárolást, hogy mezőérték alapján lekérdezhesse a bejegyzéseket:

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

Kiemelt bejegyzések lekérdezése:

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

Globális webhelybeállítások

A webhely egészére vonatkozó konfiguráció tárolása beállításokban:

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

Elérés bárhol a webhelyen:

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

Bejegyzésmeta és beállítás

Adatokhoz, amelyeknek bejegyzésszinten és globálisan is elérhetőnek kell lenniük:

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

Alapértelmezett kulcsnevek

Ha nem ad meg egyéni kulcsot, a Blockstudio automatikusan létrehoz egyet:

Tárolási típus Alapértelmezett kulcsformátum Példa
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

A blokk neve normalizálva van (a perjeleket aláhúzásjelek helyettesítik).

Figyelmeztetés

Éles használathoz egyéni kulcsok ajánlottak. Az alapértelmezett kulcsok megváltozhatnak, ha átnevezi a blokkot.