Ukládání
Ve výchozím nastavení se všechny hodnoty polí ukládají jako atributy bloku uvnitř komentáře bloku v obsahu příspěvku. Funkce ukládání umožňuje ukládat hodnoty také do metadat příspěvku (wp_postmeta) nebo do možností (wp_options), takže jsou dostupné i mimo kontext bloku.
Proč používat ukládání?
Atributy bloků se ukládají do komentářů HTML v obsahu příspěvku, takže jsou dostupné pouze při parsování obsahu bloků. Díky dalším umístěním úložiště můžete:
- Vyhledávat příspěvky podle hodnot polí pomocí
meta_query - Přistupovat k hodnotám přes REST API v bezhlavých prostředích
- Sdílet data s dalšími pluginy, například SEO, nebo s pluginy pro ukládání do mezipaměti
- Vytvářet globální nastavení, která se zachovají napříč příspěvky
Typy úložiště
| Typ | Umístění | Rozsah | Vhodné pro |
|---|---|---|---|
postMeta |
tabulka wp_postmeta |
Pro příspěvek | Data konkrétního příspěvku vhodná pro vyhledávání |
option |
tabulka wp_options |
Globální (pro celý web) | Nastavení webu, sdílené hodnoty |
Poznámka
Atributy bloku se vždy automaticky ukládají do komentáře HTML v obsahu příspěvku. Vlastnost
storagepřidává další umístění úložiště – nenahrazuje ukládání v bloku.
Konfigurace
Přidejte vlastnost storage do libovolné definice pole:
{
"name": "blockstudio/example",
"title": "Example Block",
"blockstudio": {
"attributes": [
{
"id": "subtitle",
"type": "text",
"label": "Subtitle",
"storage": {
"type": "postMeta",
"postMetaKey": "my_subtitle"
}
}
]
}
}
Vlastnosti úložiště
| Vlastnost | Typ | Popis |
|---|---|---|
type |
string | string[] |
Další umístění úložiště location(s): "postMeta", "option" |
postMetaKey |
string |
Vlastní klíč metadat (výchozí: {block_name}_{field_id}) |
optionKey |
string |
Vlastní klíč možnosti (výchozí: {block_name}_{field_id}) |
Jedno nebo více umístění úložiště
// Add post meta storage
"storage": {
"type": "postMeta"
}
// Add both post meta and option storage
"storage": {
"type": ["postMeta", "option"]
}
Jak to funguje
- Registrace: Při načtení WordPress zaregistruje Blockstudio klíče metadat a nastavení podle konfigurace polí
- Úpravy: Hodnoty se spravují jako atributy bloku v editoru (vždy se ukládají do bloku)
- Uložení: Metadata příspěvku se synchronizují při uložení příspěvku. Možnosti webu se synchronizují při zveřejnění příspěvku nebo při změně hodnoty pole u zveřejněného příspěvku.
Automatická uložení a revize nesynchronizují ani jedno umístění úložiště. Koncepty, čekající, soukromé a naplánované příspěvky mohou aktualizovat vlastní metadata, ale nemění aktivní možnosti webu. Možnosti se synchronizují při zveřejnění naplánovaného příspěvku pomocí WordPress.
Hodnoty se kopírují doslova, včetně zpětných lomítek, uvozovek a vnořených hodnot opakovače. Nepřidávejte escapování hodnot polí jako náhradu za ukládání metadat WordPress; tuto hranici řeší Blockstudio. Možnosti webu zachovávají stejné doslovné hodnoty bez dalšího escapování.
Pokud předchozí verze odstranila zpětná lomítka z kopie metadat příspěvku, po aktualizaci příspěvek znovu uložte. K obnovení kopie metadat se použije původní hodnota pole v atributech bloku.
Ukládání možností webu
Možnosti se sdílejí napříč celým webem. Publikování nového bloku zapíše hodnoty polí možností uvedené v jeho uložených atributech. Při pozdějším ukládání se každé pole porovná s předchozí uloženou verzí bloku a zapíší se jen změněné hodnoty. Uložení názvu příspěvku ani nezměněné starší kopie bloku v jiném příspěvku nepřepíše novější hodnotu možnosti.
Pole vynechané z uložených atributů ponechá svou možnost beze změny. To také chrání existující možnosti při přidání nového pole do block.json. Výslovné null možnost smaže; prázdné řetězce, false, 0 a prázdná pole se uloží jako hodnoty. Odebrání bloku jeho možnosti nesmaže.
Každou sdílenou možnost spravujte pomocí jednoho určeného publikovaného bloku. Pokud více bloků záměrně změní tutéž možnost, při uložení se použije naposledy změněná hodnota. Úložiště nenačítá aktuální možnost do každého bloku: každý blok si ponechává vlastní hodnoty polí v obsahu příspěvku.
U stránek založených na souborech umožňuje trvalý blok key nástroji Blockstudio rozpoznat tentýž blok i po jeho přesunutí v dokumentu. Bloky bez klíče se párují podle názvu a pozice.
Přístup k uloženým hodnotám
V šablonách bloků
Uvnitř šablony bloku jsou hodnoty polí vždy dostupné prostřednictvím $attributes:
PHP
<div>
<h1><?php echo $a['subtitle']; ?></h1>
</div>
Twig
<div>
<h1>{{ a.subtitle }}</h1>
</div>
Metadata příspěvku (mimo kontext bloku)
K hodnotám uloženým v postMeta lze přistupovat odkudkoli 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) }}
Metadata příspěvku jsou dostupná také prostřednictvím REST API:
GET /wp-json/wp/v2/posts/123
# Response includes: { "meta": { "my_subtitle": "Hello World" } }
Možnosti (globální hodnoty)
K hodnotám uloženým v option lze přistupovat z celého webu:
PHP
$company_name = get_option( 'site_company_name' );
Twig
{{ function('get_option', 'site_company_name') }}
Příklady
Pole metadat SEO
Ukládejte data SEO do metadat příspěvku kvůli kompatibilitě s pluginy 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"
}
}
]
}
}
Doporučený obsah s dotazováním
Přidejte úložiště metadat příspěvku, abyste mohli vyhledávat příspěvky podle hodnoty pole:
{
"blockstudio": {
"attributes": [
{
"id": "featured",
"type": "toggle",
"label": "Featured",
"storage": {
"type": "postMeta",
"postMetaKey": "is_featured"
}
}
]
}
}
Vyhledejte doporučené příspěvky:
$featured_posts = get_posts([
'meta_key' => 'is_featured',
'meta_value' => '1',
]);
Globální nastavení webu
Ukládejte konfiguraci platnou pro celý web 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"
}
}
]
}
}
Přístup odkudkoli na webu:
<footer>
<p>© <?php echo get_option( 'site_company_name' ); ?></p>
<p>Contact: <?php echo get_option( 'site_support_email' ); ?></p>
</footer>
Metadata příspěvku a možnost
Pro data, která musí být dostupná na úrovni příspěvku i globálně:
{
"blockstudio": {
"attributes": [
{
"id": "important_value",
"type": "text",
"label": "Important Value",
"storage": {
"type": ["postMeta", "option"],
"postMetaKey": "important_meta",
"optionKey": "important_option"
}
}
]
}
}
Výchozí názvy klíčů
Pokud nezadáte vlastní klíč, Blockstudio jej vygeneruje automaticky:
| Typ úložiště | Výchozí formát klíče | Příklad |
|---|---|---|
postMeta |
{block_name}_{field_id} |
blockstudio_example_subtitle |
option |
{block_name}_{field_id} |
blockstudio_example_subtitle |
Název bloku se upraví na bezpečný formát (lomítka se nahradí podtržítky).
Varování
Pro produkční použití se doporučují vlastní klíče. Výchozí klíče se mohou změnit, pokud blok přejmenujete.