Ukladanie
Predvolene sa všetky hodnoty polí ukladajú ako atribúty bloku v komentári bloku v obsahu príspevku. Funkcia ukladania umožňuje ukladať hodnoty aj do metaúdajov príspevku (wp_postmeta) alebo do možností (wp_options), vďaka čomu sú dostupné aj mimo kontextu bloku.
Prečo používať ukladanie?
Atribúty bloku sa ukladajú do komentárov HTML v obsahu príspevku, takže sú dostupné iba pri parsovaní obsahu bloku. Použitím ďalších úložísk môžete:
- Vyhľadávať príspevky podľa hodnôt polí pomocou
meta_query - Pristupovať k hodnotám cez REST API v bezhlavých nastaveniach
- Zdieľať údaje s ďalšími pluginmi, ako sú SEO alebo pluginy na ukladanie do vyrovnávacej pamäte
- Vytvárať globálne nastavenia, ktoré zostanú zachované naprieč príspevkami
Typy úložísk
| Typ | Umiestnenie | Rozsah | Vhodné na |
|---|---|---|---|
postMeta |
Tabuľka wp_postmeta |
Pre každý príspevok | Údaje konkrétne pre príspevok, ktoré možno vyhľadávať |
option |
Tabuľka wp_options |
Globálne (pre celý web) | Nastavenia webu, zdieľané hodnoty |
Poznámka
Atribúty bloku sa vždy automaticky ukladajú (do komentára HTML v obsahu príspevku). Vlastnosť
storagepridáva ďalšie úložiská – nenahrádza ukladanie do bloku.
Konfigurácia
Pridajte vlastnosť storage do ľubovoľnej definície poľa:
{
"name": "blockstudio/example",
"title": "Example Block",
"blockstudio": {
"attributes": [
{
"id": "subtitle",
"type": "text",
"label": "Subtitle",
"storage": {
"type": "postMeta",
"postMetaKey": "my_subtitle"
}
}
]
}
}
Vlastnosti ukladania
| Vlastnosť | Typ | Popis |
|---|---|---|
type |
string | string[] |
Ďalšie úložisko location(s): "postMeta", "option" |
postMetaKey |
string |
Vlastný kľúč metaúdajov (predvolené: {block_name}_{field_id}) |
optionKey |
string |
Vlastný kľúč možnosti (predvolené: {block_name}_{field_id}) |
Jedno alebo viac úložísk
// Add post meta storage
"storage": {
"type": "postMeta"
}
// Add both post meta and option storage
"storage": {
"type": ["postMeta", "option"]
}
Ako to funguje
- Registrácia: Po načítaní WordPress zaregistruje Blockstudio meta kľúče a nastavenia podľa konfigurácie polí
- Úpravy: Hodnoty sa spravujú ako atribúty bloku v editore (vždy sa ukladajú do bloku)
- Uloženie: Metaúdaje príspevku sa synchronizujú pri jeho uložení. Možnosti webu sa synchronizujú pri zverejnení príspevku alebo pri zmene hodnoty poľa v už zverejnenom príspevku.
Automaticky ukladané verzie a revízie sa nesynchronizujú ani do jedného z úložisk. Koncepty, čakajúce, súkromné a naplánované príspevky môžu aktualizovať vlastné metadáta príspevku, ale nemenia možnosti aktívnej stránky. Možnosti sa synchronizujú pri publikovaní naplánovaného príspevku pomocou WordPress.
Hodnoty sa kopírujú doslovne vrátane spätných lomiek, úvodzoviek a vnorených hodnôt opakovača. Nepridávajte escapovanie hodnôt polí ako kompenzáciu za ukladanie metaúdajov WordPress; o túto hranicu sa stará Blockstudio. Možnosti webu zachovávajú rovnaké doslovné hodnoty bez ďalšieho pridávania spätných lomiek.
Ak staršia verzia odstránila spätné lomky z kópie metaúdajov príspevku, po aktualizácii príspevok znova uložte. Na obnovenie kópie metaúdajov sa použije pôvodná hodnota poľa v atribútoch bloku.
Ukladanie možností stránky
Možnosti sa zdieľajú na celom webe. Publikovaním nového bloku sa zapíšu polia možností uvedené v jeho uložených atribútoch. Pri ďalších uloženiach sa každé pole porovná s predchádzajúcou uloženou verziou daného bloku a zapíšu sa iba zmenené hodnoty. Uloženie názvu príspevku ani nezmenenej staršej kópie bloku v inom príspevku neprepíše novšiu hodnotu možnosti.
Pole vynechané z uložených atribútov ponechá svoju možnosť nedotknutú. Tým sa chránia aj existujúce možnosti pri pridaní nového poľa do block.json. Výslovné null možnosť odstráni; prázdne reťazce, false, 0 a prázdne polia sa ukladajú ako hodnoty. Odstránením bloku sa jeho možnosti nevymažú.
Na správu každej zdieľanej možnosti používajte jeden určený publikovaný blok. Ak viacero blokov zámerne zmení tú istú možnosť, vyhrá posledná uložená zmenená hodnota. Úložisko nenačítava aktuálnu možnosť do každého bloku: každý blok si v obsahu príspevku uchováva vlastné hodnoty polí.
Pri stránkach založených na súboroch umožňuje trvalý blok key nástroju Blockstudio rozpoznať ten istý blok aj po jeho presunutí v dokumente. Bloky bez kľúča sa párujú podľa názvu a pozície.
Prístup k uloženým hodnotám
V šablónach blokov
V šablóne bloku sú hodnoty polí vždy dostupné cez $attributes:
PHP
<div>
<h1><?php echo $a['subtitle']; ?></h1>
</div>
Twig
<div>
<h1>{{ a.subtitle }}</h1>
</div>
Metadáta príspevku (mimo kontextu bloku)
K hodnotám uloženým v postMeta možno pristupovať kdekoľvek v WordPress:
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
{# Using Timber #}
{{ post.meta('my_subtitle') }}
{# Or via function #}
{{ function('get_post_meta', post.id, 'my_subtitle', true) }}
Metadáta príspevku sú dostupné aj cez REST API:
GET /wp-json/wp/v2/posts/123
# Response includes: { "meta": { "my_subtitle": "Hello World" } }
Možnosti (globálne hodnoty)
Hodnoty uložené v option sú dostupné na celom webe:
PHP
$company_name = get_option( 'site_company_name' );
Twig
{{ function('get_option', 'site_company_name') }}
Príklady
Polia metadát SEO
Ukladajte údaje SEO do metadát príspevku, aby boli kompatibilné s pluginmi SEO:
{
"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"
}
}
]
}
}
Odporúčaný obsah s dotazovaním
Pridajte ukladanie metadát príspevku, aby ste mohli vyhľadávať príspevky podľa hodnoty poľa:
{
"blockstudio": {
"attributes": [
{
"id": "featured",
"type": "toggle",
"label": "Featured",
"storage": {
"type": "postMeta",
"postMetaKey": "is_featured"
}
}
]
}
}
Vyhľadajte odporúčané príspevky:
$featured_posts = get_posts([
'meta_key' => 'is_featured',
'meta_value' => '1',
]);
Globálne nastavenia webu
Konfiguráciu platnú pre celý web ukladajte do možností:
{
"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"
}
}
]
}
}
Pristupujte k nim kdekoľvek na svojom webe:
<footer>
<p>© <?php echo get_option( 'site_company_name' ); ?></p>
<p>Contact: <?php echo get_option( 'site_support_email' ); ?></p>
</footer>
Metadáta príspevku a možnosť
Pre údaje, ktoré musia byť dostupné na úrovni príspevku aj globálne:
{
"blockstudio": {
"attributes": [
{
"id": "important_value",
"type": "text",
"label": "Important Value",
"storage": {
"type": ["postMeta", "option"],
"postMetaKey": "important_meta",
"optionKey": "important_option"
}
}
]
}
}
Predvolené názvy kľúčov
Ak nezadáte vlastný kľúč, Blockstudio ho vygeneruje automaticky:
| Typ úložiska | Formát predvoleného kľúča | Príklad |
|---|---|---|
postMeta |
{block_name}_{field_id} |
blockstudio_example_subtitle |
option |
{block_name}_{field_id} |
blockstudio_example_subtitle |
Názov bloku sa upraví (lomky sa nahradia podčiarkovníkmi).
Upozornenie
Pre produkčné použitie sa odporúčajú vlastné kľúče. Predvolené kľúče sa môžu zmeniť, ak premenujete blok.