Към съдържанието

Съхранение

По подразбиране всички стойности на полетата се съхраняват като атрибути на блока в коментара на блока в съдържанието на публикацията. Функцията за съхранение позволява допълнително да съхранявате стойностите в метаданните на публикацията (wp_postmeta) или в опциите (wp_options), така че да са достъпни извън контекста на блока.

Защо да използвате съхранение?

Атрибутите на блока се съхраняват в коментари HTML в съдържанието на публикацията, което означава, че са достъпни само при анализиране на съдържанието на блока. Като използвате допълнителни места за съхранение, можете да:

  • Заявявате публикации по стойности на полета чрез meta_query
  • Достъпвате стойности чрез REST API при конфигурации без фронтенд
  • Споделяте данни с други разширения, като SEO или разширения за кеширане
  • Създавате глобални настройки, които се запазват във всички публикации

Типове съхранение

Тип Местоположение Обхват Подходящо за
postMeta таблица wp_postmeta За публикация Данни за конкретна публикация, по които може да се правят заявки
option таблица wp_options Глобален (за целия сайт) Настройки на сайта, споделени стойности

Забележка

Съхранението на атрибутите на блока (в коментара HTML в съдържанието на публикацията) винаги се извършва автоматично. Свойството storage добавя допълнителни места за съхранение, а не замества съхранението в блока.

Конфигурация

Добавете свойството storage към всяка дефиниция на поле:

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

Свойства за съхранение

Свойство Тип Описание
type string | string[] Допълнителни места за съхранение location(s): "postMeta", "option"
postMetaKey string Персонализиран ключ за метаданни (по подразбиране: {block_name}_{field_id})
optionKey string Персонализиран ключ за опции (по подразбиране: {block_name}_{field_id})

Едно или няколко места за съхранение

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

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

Как работи

  1. Регистрация: При зареждане на WordPress, Blockstudio регистрира мета ключове и настройки според конфигурацията на полетата ви
  2. Редактиране: Стойностите се управляват като атрибути на блока в редактора (винаги се съхраняват в блока)
  3. Запазване: Метаданните на публикацията се синхронизират при запазването ѝ. Опциите на сайта се синхронизират при публикуването на публикацията или при промяна на стойността на поле в вече публикувана публикация.

Автоматичните чернови и редакциите не синхронизират нито едно от местата за съхранение. Черновите, чакащите, частните и насрочените публикации могат да актуализират собствените си метаданни, но не променят активните опции на сайта. Опциите се синхронизират при публикуването на насрочена публикация от WordPress.

Стойностите се копират буквално, включително обратните наклонени черти, кавичките и вложените стойности на повторителите. Не добавяйте екраниране към стойностите на полетата, за да компенсирате съхранението на метаданни в WordPress; Blockstudio обработва тази граница. Опциите на сайта запазват същите буквални стойности без допълнително добавяне на наклонени черти.

Ако предишна версия е премахвала обратните наклонени черти от копието на метаданните на публикация, запишете публикацията отново след надстройването. Оригиналната стойност на полето в атрибутите на блока се използва за обновяване на копието на метаданните.

Запазване на опциите на сайта

Опциите се споделят в целия сайт. Публикуването на нов блок записва полетата за опции, подадени в запазените му атрибути. При следващи запазвания всяко поле се сравнява с предишната запазена версия на този блок и се записват само променените стойности. Запазването на заглавието на публикация или на непроменено по-старо копие на блока в друга публикация не презаписва по-нова стойност на опция.

Поле, което липсва от запазените атрибути, оставя опцията непроменена. Това също предпазва съществуващите опции, когато към block.json се добави ново поле. Изрично null изтрива опция; празните низове, false, 0 и празните масиви се запазват като стойности. Премахването на блок не изтрива опциите му.

Използвайте един определен публикуван блок, за да управлявате всяка споделена опция. Ако няколко блока умишлено променят една и съща опция, печели последната запазена променена стойност. Съхранението не зарежда текущата опция във всеки блок: всеки блок запазва собствените си стойности на полетата в съдържанието на публикацията.

За страници, базирани на файлове, постоянен ключ на блок key позволява на Blockstudio да разпознава същия блок, след като бъде преместен в документа. Блоковете без ключ се съпоставят по име и позиция.

Достъп до съхранените стойности

В шаблоните на блокове

В шаблона на блока стойностите на полетата винаги са достъпни чрез $attributes:

PHP

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

Twig

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

Метаданни на публикация (извън контекста на блок)

Стойностите, съхранени в postMeta, са достъпни навсякъде в 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) }}

Метаданните на публикацията са достъпни и чрез REST API:

Обвивка
GET /wp-json/wp/v2/posts/123
# Response includes: { "meta": { "my_subtitle": "Hello World" } }

Опции (глобални стойности)

Стойностите, съхранени в option, са достъпни в целия сайт:

PHP

PHP
$company_name = get_option( 'site_company_name' );

Twig

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

Примери

Метаполета на SEO

Съхранявайте данни на SEO в метаданните на публикацията за съвместимост с плъгини за SEO:

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

Добавете съхранение в метаданните на публикацията, за да можете да търсите публикации по стойност на поле:

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

Заявка за препоръчани публикации:

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

Глобални настройки на сайта

Съхранявайте конфигурацията за целия сайт в опциите:

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

Достъп навсякъде в сайта:

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

Метаданни на публикация и опция

За данни, които трябва да са достъпни както на ниво публикация, така и глобално:

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

Имена на ключовете по подразбиране

Ако не зададете персонализиран ключ, Blockstudio автоматично генерира такъв:

Тип съхранение Формат на ключа по подразбиране Пример
postMeta {block_name}_{field_id} blockstudio_example_subtitle
option {block_name}_{field_id} blockstudio_example_subtitle

Името на блока се нормализира (наклонените черти се заменят с долни черти).

Предупреждение

За продукционна употреба се препоръчват персонализирани ключове. Ключовете по подразбиране може да се променят, ако преименувате блока.