Zum Inhalt springen

MediaPlaceholder

Die Komponente MediaPlaceholder stellt einen Platzhalter bereit, über den du Medienelemente zu einem Block hinzufügen kannst. Dieselbe Komponente wird im Block core/image verwendet. Sie basiert auf der gleichnamigen Komponente React.

Grundlegende Verwendung

Um MediaPlaceholder in der einfachsten Form zu verwenden, musst du das passende Attribut zu deinem block.json hinzufügen und die Komponente MediaPlaceholder in deinen Block aufnehmen.

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

Sobald eine Mediendatei ausgewählt wurde, wird die Komponente MediaPlaceholder nicht mehr gerendert.

Eigenschaften

accept

Ein an FormFileUpload übergebener String, der dem Browser mitteilt, welche Dateitypen im Upload-Fenster hochgeladen werden dürfen. Der Browser verwendet dafür e.g.: image/* oder video/*. Weitere Informationen zu diesem String findest du in der MDN-Dokumentation.

allowedTypes

Array mit den Medientypen, die hochgeladen oder aus der Mediathek ausgewählt werden dürfen. Jeder Typ ist ein String, der den allgemeinen MIME-Typ e.g.: image, audio, text oder den vollständigen MIME-Typ e.g.: audio/mpeg, image/gif enthalten kann. Wenn allowedTypes nicht gesetzt ist, sind alle MIME-Typen zulässig.

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

Wenn true, öffnet die MediaUpload-Komponente automatisch die Auswahl des jeweiligen Mediums.

disableDropZone

Wenn true, wird die Drop Zone nicht gerendert. Nutzer können keine Medien per Drag & Drop in die Komponente oder den Block ziehen. Die UI-Steuerelemente zum Hochladen von Medien per Datei, URL oder Medienbibliothek bleiben erhalten.

dropZoneUIOnly

Wenn true, wird nur die Drop Zone gerendert. Es werden keine UI-Steuerelemente zum Hochladen von Medien angezeigt. Die Prop disableDropZone hat weiterhin Vorrang vor dropZoneUIOnly – sind beide auf true gesetzt, wird nichts gerendert.

icon

Dashicon, das links neben dem Titel angezeigt wird.

isAppender

Wenn true, passt die Eigenschaft das Aussehen des Platzhalters an Szenarien an, in denen neue Dateien zu einer bestehenden Dateigruppe hinzugefügt werden, e.g., etwa beim Hinzufügen von Dateien zu einer Galerie. Wenn false, wird der Standardstil des Platzhalters verwendet.

disableMediaButtons

Wenn true, wird nur die Drop Zone gerendert. Es werden keine UI-Steuerelemente zum Hochladen von Medien angezeigt.

labels

Ein Objekt, das die Eigenschaften title und instructions enthalten kann.

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') }}" />

Repeater-Felder

MediaPlaceholder funktioniert in Repeater-Feldern. Verwende die Klammernotation mit dem Schleifenindex, um die richtige Zeile anzusprechen.

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

Der Wert attribute folgt dem Muster repeaterId[index].fieldId, wobei index die nullbasierte Zeilennummer der Schleife ist.