Pāriet uz saturu

Glabāšana

Pēc noklusējuma visas lauku vērtības tiek glabātas kā bloka atribūti bloka komentārā ieraksta saturā. Glabāšanas funkcija ļauj vērtības papildus saglabāt ieraksta meta datos (wp_postmeta) vai opcijās (wp_options), lai tām varētu piekļūt ārpus bloka konteksta.

Kāpēc izmantot glabāšanu?

Bloka atribūti tiek glabāti HTML komentāros ieraksta saturā, tāpēc tiem var piekļūt tikai, parsējot bloka saturu. Izmantojot papildu glabāšanas vietas, varat:

  • Vaicāt ierakstus pēc lauku vērtībām, izmantojot meta_query
  • Piekļūt vērtībām, izmantojot REST API, bezgalvenes iestatījumos
  • Kopīgot datus ar citiem spraudņiem, piemēram, SEO, vai kešatmiņas spraudņiem
  • Izveidot globālus iestatījumus, kas saglabājas starp ierakstiem

Glabāšanas veidi

Veids Atrašanās vieta Tvērums Piemērotākais lietojums
postMeta tabula wp_postmeta Katram ierakstam Vaicājumiem pieejami konkrēta ieraksta dati
option tabula wp_options Globāls (visai vietnei) Vietnes iestatījumi, koplietojamas vērtības

Piezīme

Bloka atribūtu glabāšana (ieraksta satura komentārā HTML) vienmēr notiek automātiski. Rekvizīts storage pievieno papildu glabāšanas vietas — tas neaizstāj bloka glabāšanu.

Konfigurācija

Pievienojiet rekvizītu storage jebkuras lauka definīcijai:

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

Glabāšanas rekvizīti

Rekvizīts Tips Apraksts
type string | string[] Papildu glabāšanas location(s): "postMeta", "option"
postMetaKey string Pielāgota meta atslēga (pēc noklusējuma: {block_name}_{field_id})
optionKey string Pielāgota opcijas atslēga (pēc noklusējuma: {block_name}_{field_id})

Viena vai vairākas glabāšanas vietas

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

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

Kā tas darbojas

  1. Reģistrācija: ielādējot WordPress, Blockstudio reģistrē meta atslēgas un iestatījumus, pamatojoties uz lauku konfigurācijām.
  2. Rediģēšana: vērtības redaktorā tiek pārvaldītas kā bloka atribūti (vienmēr tiek saglabātas blokā).
  3. Saglabāšana: ieraksta meta dati tiek sinhronizēti, saglabājot ierakstu. Vietnes opcijas tiek sinhronizētas, publicējot ierakstu vai mainot publicēta ieraksta lauka vērtību.

Automātiskās saglabāšanas dati un versijas nesinhronizē nevienu no glabāšanas vietām. Melnrakstu, gaidošu, privātu un ieplānotu ierakstu meta datus var atjaunināt, taču tie nemaina aktīvās vietnes opcijas. Ieplānotam ierakstam opcijas tiek sinhronizētas, kad WordPress to publicē.

Vērtības tiek kopētas burtiski, tostarp slīpsvītras, pēdiņas un ligzdotu atkārtotāju vērtības. Nepievienojiet lauku vērtībām rakstzīmju ekranēšanu, lai kompensētu WordPress metadatu glabāšanu; šo robežu apstrādā Blockstudio. Vietnes opcijās tiek saglabātas tās pašas burtiskās vērtības bez papildu slīpsvītrām.

Ja iepriekšējā versija noņēma slīpsvītras no ziņas metadatu kopijas, pēc jaunināšanas saglabājiet ziņu vēlreiz. Sākotnējā lauka vērtība tā bloka atribūtos tiek izmantota, lai atsvaidzinātu metadatu kopiju.

Vietnes opciju saglabāšana

Opcijas tiek koplietotas visā vietnē. Publicējot jaunu bloku, opcijās tiek ierakstīti lauku dati no tā saglabātajiem atribūtiem. Vēlāk, saglabājot bloku, katrs lauks tiek salīdzināts ar tā iepriekšējo saglabāto versiju un tiek ierakstītas tikai mainītās vērtības. Saglabājot ieraksta virsrakstu vai nemainītu vecāku bloka kopiju citā ierakstā, jaunāka opcijas vērtība netiek pārrakstīta.

Ja saglabātajos atribūtos lauks nav norādīts, tā opcija paliek nemainīta. Tas arī aizsargā esošās opcijas, kad laukam tiek pievienots block.json. Skaidri norādīts null dzēš opciju; tukšas virknes, false, 0 un tukši masīvi tiek saglabāti kā vērtības. Bloka noņemšana tā opcijas nedzēš.

Katras koplietotās opcijas pārvaldībai izmantojiet vienu īpaši šim nolūkam paredzētu publicētu bloku. Ja vairāki bloki apzināti maina vienu un to pašu opciju, tiek saglabāta pēdējā mainītā vērtība. Krātuve neielādē pašreizējo opciju katrā blokā: katrs bloks saglabā savas lauku vērtības ieraksta saturā.

Lapas, kuru pamatā ir faili, pastāvīga bloka key ļauj Blockstudio atpazīt to pašu bloku arī pēc tā pārvietošanas dokumentā. Bloki bez atslēgas tiek piemeklēti pēc bloka nosaukuma un pozīcijas.

Piekļuve saglabātajām vērtībām

Bloku veidnēs

Bloka veidnē lauku vērtības vienmēr ir pieejamas, izmantojot $attributes:

PHP

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

Twig

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

Ieraksta metadati (ārpus bloka konteksta)

Vērtībām, kas saglabātas postMeta, var piekļūt jebkurā vietā 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) }}

Ieraksta metadati ir pieejami arī, izmantojot REST API:

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

Opcijas (globālās vērtības)

Vērtībām, kas saglabātas option, var piekļūt visā vietnē:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Piemēri

SEO metadatu lauki

Saglabājiet SEO datus ieraksta metadatos, lai nodrošinātu saderību ar SEO spraudņiem:

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

Pievienojiet ieraksta metadatu krātuvi, lai varētu vaicājumos atlasīt ierakstus pēc lauka vērtības:

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

Vaicājiet piedāvātos ierakstus:

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

Globālie vietnes iestatījumi

Saglabājiet visas vietnes konfigurāciju opcijās:

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

Piekļūstiet tām jebkurā vietnes vietā:

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

Ieraksta metadati un opcija

Datiem, kam jābūt pieejamiem gan ieraksta, gan globālā līmenī:

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

Noklusētie atslēgu nosaukumi

Ja nenorādāt pielāgotu atslēgu, Blockstudio to ģenerē automātiski:

Krātuves veids Noklusētās atslēgas formāts Piemērs
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Bloka nosaukums tiek normalizēts (slīpsvītras aizstātas ar pasvītrām).

Brīdinājums

Ieteicams izmantot pielāgotas atslēgas produkcijas vidē. Noklusētās atslēgas var mainīties, ja pārdēvējat bloku.