Saltar al contenido

MediaPlaceholder

El componente MediaPlaceholder proporciona un marcador de posición para añadir elementos multimedia a un bloque. El mismo componente se utiliza en el bloque core/image. Se basa en el componente React con el mismo nombre.

Uso básico

Para usar MediaPlaceholder de la forma más básica, debes añadir el atributo adecuado a tu block.json y añadir el componente MediaPlaceholder a tu bloque.

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

Una vez seleccionado un archivo multimedia, el componente MediaPlaceholder dejará de renderizarse.

Propiedades

accept

Cadena que se pasa a FormFileUpload para indicar al navegador qué tipos de archivo se pueden subir a la ventana de carga que usa el navegador e.g.: image/* o video/*. Encontrarás más información sobre esta cadena en la documentación de MDN.

allowedTypes

Matriz con los tipos de medios que se pueden subir o seleccionar de la biblioteca multimedia. Cada tipo es una cadena que puede contener el tipo MIME general e.g.: image, audio, text, o el tipo MIME completo e.g.: audio/mpeg, image/gif. Si no se establece allowedTypes, se permiten todos los tipos 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

Si es true, el componente MediaUpload abre automáticamente el selector de la plataforma correspondiente.

disableDropZone

Si es true, no se renderiza la zona de soltar. Los usuarios no podrán arrastrar y soltar medios en el componente ni en el bloque. Los controles UI para subir medios mediante archivo, URL o la biblioteca multimedia seguirán disponibles.

dropZoneUIOnly

Si es true, solo se renderiza la zona de soltar. No se mostrarán controles UI para subir medios. La propiedad disableDropZone sigue teniendo prioridad sobre dropZoneUIOnly: si se especifican ambas como true, no se renderizará nada.

icon

Dashicon que se mostrará a la izquierda del título.

isAppender

Si es true, la propiedad cambia el aspecto del marcador de posición para adaptarlo a situaciones en las que se añaden archivos nuevos a un conjunto existente, e.g., por ejemplo, al añadir archivos a una galería. Si es false, se usa el estilo predeterminado del marcador de posición.

disableMediaButtons

Si es true, solo se renderiza la zona de soltar. No se mostrarán controles UI para subir medios.

labels

Objeto que puede contener las propiedades title e 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') }}" />

Campos repetidores

MediaPlaceholder funciona dentro de campos repetidores. Usa la notación con corchetes y el índice del bucle para seleccionar la fila correcta.

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

El valor attribute sigue el patrón repeaterId[index].fieldId, donde index es el número de fila del bucle, empezando por cero.