Przejdź do treści

MediaPlaceholder

Komponent MediaPlaceholder udostępnia symbol zastępczy do dodawania plików multimedialnych do bloku. Ten sam komponent jest używany w bloku core/image. Bazuje on na komponencie React o tej samej nazwie.

Podstawowe użycie

Aby użyć MediaPlaceholder w najprostszej postaci, dodaj odpowiedni atrybut do block.json oraz komponent MediaPlaceholder do bloku.

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 %}

Po wybraniu pliku multimedialnego komponent MediaPlaceholder nie będzie już renderowany.

Właściwości

accept

Ciąg przekazywany do FormFileUpload, który informuje przeglądarkę, jakie typy plików można przesłać w oknie przesyłania używającym e.g. Są to na przykład image/* lub video/*. Więcej informacji o tym ciągu zawiera dokumentacja MDN.

allowedTypes

Tablica typów multimediów do przesłania lub wybrania z biblioteki. Każdy typ jest ciągiem, który może zawierać ogólny typ MIME e.g, np. image, audio, text, albo pełny typ MIME e.g, np. audio/mpeg lub image/gif. Jeśli nie ustawiono allowedTypes, dozwolone są wszystkie typy 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

Jeśli wartość wynosi true, komponent MediaUpload automatycznie otwiera selektor odpowiedniej platformy.

disableDropZone

Jeśli wartość wynosi true, strefa upuszczania nie będzie renderowana. Użytkownicy nie będą mogli przeciągać i upuszczać plików multimedialnych do komponentu ani bloku. UI elementy sterujące przesyłaniem multimediów z pliku, adresu URL lub biblioteki pozostaną dostępne.

dropZoneUIOnly

Jeśli wartość wynosi true, renderowana będzie tylko strefa upuszczania. Nie będą wyświetlane elementy sterujące UI do przesyłania multimediów. Właściwość disableDropZone ma pierwszeństwo przed dropZoneUIOnly — ustawienie obu wartości na true spowoduje, że nic nie zostanie wyrenderowane.

Ikona

Dashicon wyświetlany po lewej stronie tytułu.

isAppender

Jeśli wartość wynosi true, właściwość zmienia wygląd symbolu zastępczego, aby pasował do sytuacji, w których do istniejącego już zestawu plików dodawane są nowe, e.g np. pliki do galerii. Jeśli wartość wynosi false, używany jest domyślny styl symbolu zastępczego.

disableMediaButtons

Jeśli wartość wynosi true, renderowana będzie tylko strefa upuszczania. Nie będą wyświetlane żadne elementy sterujące UI do przesyłania multimediów.

Etykiety

Obiekt, który może zawierać właściwości title i 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') }}" />

Pola powtarzalne

MediaPlaceholder działa w polach powtarzalnych. Użyj notacji nawiasowej z indeksem pętli, aby wskazać właściwy wiersz.

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 %}

Wartość attribute ma postać repeaterId[index].fieldId, gdzie index to numer wiersza w pętli, liczony od zera.