MediaPlaceholder
Le composant MediaPlaceholder fournit un espace réservé pour ajouter des médias à un bloc. Le même composant est utilisé dans le bloc core/image. Il est basé sur le composant React du même nom.
Utilisation de base
Pour utiliser MediaPlaceholder sous sa forme la plus simple, ajoutez l’attribut approprié à votre block.json et le composant MediaPlaceholder à votre bloc.
{
"$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
<MediaPlaceholder attribute="media" />
<?php foreach ($a['media'] as $file) {
echo wp_get_attachment_image($file['ID']);
} ?>
Twig
<MediaPlaceholder attribute="media" />
{% for file in a.media %}
{{ fn('wp_get_attachment_image', file.ID) }}
{% endfor %}
Une fois un fichier média sélectionné, le composant MediaPlaceholder ne sera plus affiché.
Propriétés
accept
Chaîne transmise à FormFileUpload pour indiquer au navigateur les types de fichiers pouvant être téléversés dans sa fenêtre de téléversement à l’aide de e.g. : image/* ou video/*. Pour en savoir plus sur cette chaîne, consultez la documentation MDN.
allowedTypes
Tableau des types de médias à téléverser ou à sélectionner dans la médiathèque. Chaque type est une chaîne qui peut contenir le type MIME général e.g : image, audio, texte, ou le type MIME complet e.g : audio/mpeg, image/gif. Si allowedTypes n’est pas défini, tous les types MIME sont autorisés.
PHP
<MediaPlaceholder allowedTypes="<?php echo esc_attr(wp_json_encode(['image', 'video'])); ?>" />
Twig
<MediaPlaceholder allowedTypes="{{ ['image', 'video']|json_encode|escape('html_attr') }}" />
autoOpenMediaUpload
Si la valeur est true, le composant MediaUpload ouvre automatiquement le sélecteur de la plateforme concernée.
disableDropZone
Si la valeur est true, la zone de dépôt ne sera pas affichée. Les utilisateurs ne pourront pas glisser-déposer de médias dans le composant ou le bloc. Les commandes UI permettant de téléverser des médias depuis un fichier, une URL ou la médiathèque resteront disponibles.
dropZoneUIOnly
Si la valeur est true, seule la zone de dépôt sera affichée. Aucune commande UI de téléversement de médias ne sera affichée. La propriété disableDropZone reste prioritaire sur dropZoneUIOnly : si les deux valent true, rien ne sera affiché.
icon
Dashicon affichée à gauche du titre.
isAppender
Si la valeur est true, cette propriété adapte l’apparence de l’espace réservé aux situations où de nouveaux fichiers sont ajoutés à un ensemble de fichiers existant, e.g., par exemple lors de l’ajout de fichiers à une galerie. Si la valeur est false, le style d’espace réservé par défaut est utilisé.
disableMediaButtons
Si la valeur est true, seule la zone de dépôt sera affichée. Aucune commande UI de téléversement de médias ne sera affichée.
labels
Objet pouvant contenir les propriétés title et instructions.
PHP
<MediaPlaceholder labels="<?php echo esc_attr(wp_json_encode(['title' => 'Custom title', 'instructions' => 'Custom instructions'])); ?>" />
Twig
<MediaPlaceholder labels="{{ {title: 'Custom title', instructions: 'Custom instructions'}|json_encode|escape('html_attr') }}" />
Champs répétables
MediaPlaceholder fonctionne dans les champs répétables. Utilisez la notation entre crochets avec l’index de la boucle pour cibler la bonne ligne.
{
"blockstudio": {
"attributes": [
{
"id": "items",
"type": "repeater",
"attributes": [
{
"id": "image",
"type": "files"
}
]
}
]
}
}
<?php foreach ($a['items'] as $index => $item) : ?>
<MediaPlaceholder attribute="items[<?php echo $index; ?>].image" />
<?php endforeach; ?>
{% for item in a.items %}
<MediaPlaceholder attribute="items[{{ loop.index0 }}].image" />
{% endfor %}
La valeur attribute suit le modèle repeaterId[index].fieldId, où index représente le numéro de ligne de la boucle, en commençant à zéro.