wp_register_block_metadata_collection() の説明と使用例

WordPressの関数wp_register_block_metadata_collection()は、ブロックメタデータのコレクションを登録するために使用されます。この関数は、特定のブロックに関連するメタデータを定義し、それをブロックエディター内で利用可能にするために役立ちます。

シンタックス

wp_register_block_metadata_collection( string $block_type, array $metadata );

引数の説明:

$block_type (string) — 登録するブロックのタイプ。
$metadata (array) — ブロックメタデータのコレクション。

例 1: 基本的なブロックメタデータコレクションの登録

以下のコードは、指定したブロックタイプにメタデータを登録する基本的な例です。

wp_register_block_metadata_collection( 'core/paragraph', array(
    'align' => array(
        'default' => 'left',
    ),
) );

例 2: 複数のメタデータを登録

このコードでは、複数のメタデータを一度に登録します。

wp_register_block_metadata_collection( 'core/heading', array(
    'align' => array(
        'default' => 'center',
    ),
    'color' => array(
        'default' => 'blue',
    ),
) );

例 3: 特定のメタデータをブロックに追加

特定のメタデータをブロックに追加する例です。

wp_register_block_metadata_collection( 'core/image', array(
    'border' => array(
        'default' => 'none',
    ),
) );

例 4: カスタムメタデータの使用

カスタムブロックに独自のメタデータを追加する例です。

wp_register_block_metadata_collection( 'myplugin/custom-block', array(
    'custom_property' => array(
        'default' => 'value',
    ),
) );

例 5: メタデータの変更

登録後にメタデータを変更する方法の例です。

wp_register_block_metadata_collection( 'core/button', array(
    'color' => array(
        'default' => 'red',
    ),
) );

注意点:

登録したメタデータは、ブロックがエディターで表示される際に反映されます。
メタデータの構成方法に関しては、ブロックの設定に合わせて適切に定義してください。
ブロックタイプが正しく指定されていないと、メタデータの登録が失敗する可能性があります。