Перейти до вмісту

MediaPlaceholder

Компонент MediaPlaceholder надає заповнювач для додавання медіафайлів до блока. Цей самий компонент використовується в блоці core/image. Він створений на основі компонента React із такою самою назвою.

Основне використання

Щоб використовувати MediaPlaceholder у найпростішому вигляді, додайте відповідний атрибут до block.json і компонент MediaPlaceholder до свого блока.

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "blockstudio/media-placeholder",
  "title": "Native Block",
  "category": "text",
  "icon": "star-filled",
  "description": "Native Blockstudio MediaPlaceholder block.",
  "blockstudio": {
    "attributes": [
      {
        "id": "media",
        "type": "files"
      }
    ]
  }
}

PHP

PHP
<MediaPlaceholder attribute="media" />
<?php foreach ($a['media'] as $file) {
  echo wp_get_attachment_image($file['ID']);
} ?>

Twig

Twig
<MediaPlaceholder attribute="media" />
{% for file in a.media %}
  {{ fn('wp_get_attachment_image', file.ID) }}
{% endfor %}

Після вибору медіафайлу компонент MediaPlaceholder більше не виводиться.

Властивості

приймати

Рядок, переданий до FormFileUpload, який повідомляє браузеру, типи яких файлів можна завантажити у вікно вибору файлів. Браузер використовує e.g.: image/* або video/*. Докладніше про цей рядок читайте в документації MDN.

allowedTypes

Масив типів медіафайлів для завантаження або вибору з медіатеки. Кожен тип — це рядок, що може містити загальний тип MIME e.g.: зображення, аудіо, текст або повний тип MIME e.g.: audio/mpeg, image/gif. Якщо allowedTypes не задано, дозволено всі типи MIME.

PHP

PHP
<MediaPlaceholder allowedTypes="<?php echo esc_attr(wp_json_encode(['image', 'video'])); ?>" />

Twig

Twig
<MediaPlaceholder allowedTypes="{{ ['image', 'video']|json_encode|escape('html_attr') }}" />

autoOpenMediaUpload

Якщо значення true, компонент MediaUpload автоматично відкриває засіб вибору файлів відповідної платформи.

disableDropZone

Якщо значення true, зона перетягування не виводиться. Користувачі не зможуть перетягувати медіафайли до компонента або блока. Елементи керування UI для завантаження медіафайлів із файлу, URL-адреси або медіатеки залишаться доступними.

dropZoneUIOnly

Якщо значення true, виводиться лише зона перетягування. Елементи керування UI для завантаження медіафайлів не відображатимуться. Властивість disableDropZone має пріоритет над dropZoneUIOnly: якщо обидва значення true, нічого не буде виведено.

піктограма

Піктограма Dashicon ліворуч від заголовка.

isAppender

Якщо значення true, вигляд заповнювача змінюється для сценаріїв, коли до наявного набору файлів додають нові, наприклад e.g — додають файли до галереї. Якщо значення false, використовується типовий стиль заповнювача.

disableMediaButtons

Якщо значення true, виводиться лише зона перетягування. Елементи керування UI для завантаження медіафайлів не відображатимуться.

мітки

Об’єкт, який може містити властивості title та instructions.

PHP

PHP
<MediaPlaceholder labels="<?php echo esc_attr(wp_json_encode(['title' => 'Custom title', 'instructions' => 'Custom instructions'])); ?>" />

Twig

Twig
<MediaPlaceholder labels="{{ {title: 'Custom title', instructions: 'Custom instructions'}|json_encode|escape('html_attr') }}" />

Поля повторювача

MediaPlaceholder працює в полях повторювача. Використовуйте дужковий запис з індексом циклу, щоб указати потрібний рядок.

JSON
{
  "blockstudio": {
    "attributes": [
      {
        "id": "items",
        "type": "repeater",
        "attributes": [
          {
            "id": "image",
            "type": "files"
          }
        ]
      }
    ]
  }
}
PHP
<?php foreach ($a['items'] as $index => $item) : ?>
  <MediaPlaceholder attribute="items[<?php echo $index; ?>].image" />
<?php endforeach; ?>
Twig
{% for item in a.items %}
  <MediaPlaceholder attribute="items[{{ loop.index0 }}].image" />
{% endfor %}

Значення attribute має формат repeaterId[index].fieldId, де index — номер рядка в циклі, починаючи з нуля.