Перейти к содержимому

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 — номер строки в цикле, начиная с нуля.