コンテンツへスキップ

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

メディアライブラリからアップロードまたは選択するメディアの種類を指定する配列です。各項目は文字列で、e.gのような一般的なMIMEタイプ(image、audio、text)またはe.gのような完全なMIMEタイプを指定できます。例: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 の場合、Drop Zone はレンダリングされません。ユーザーはコンポーネントやブロックにメディアをドラッグ&ドロップできません。ファイル、URL、メディアライブラリ経由でメディアをアップロードするUIコントロールはそのまま使用できます。

dropZoneUIOnly

true の場合、Drop Zone のみがレンダリングされます。メディアをアップロードするUIコントロールは表示されません。disableDropZoneプロパティは引き続きdropZoneUIOnlyより優先されます。両方を true にすると、何もレンダリングされません。

アイコン

タイトルの左側に表示するDashiconです。

isAppender

true の場合、このプロパティによって、既存のファイルセットに新しいファイルを追加する場面に適したプレースホルダーの外観になります。e.gなど、ギャラリーへのファイル追加が該当します。false の場合は、既定のプレースホルダースタイルが使用されます。

disableMediaButtons

true の場合、Drop Zone のみがレンダリングされます。メディアをアップロードする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はループ内の0始まりの行番号です。