wp_register_core_block_metadata_collection()


WordPressのwp_register_core_block_metadata_collection()関数は、コアブロックのメタデータを登録するために使用されます。この関数は、ブロックエディタで使用されるブロックのメタデータを一括で登録するためのものです。

構文

wp_register_core_block_metadata_collection( string $collection_name, array $metadata );

引数の説明:

  • $collection_name(string) — メタデータコレクションの名前を指定します。
  • $metadata(array) — 登録するメタデータの配列を指定します。

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

この例では、基本的なメタデータコレクションを登録します。

wp_register_core_block_metadata_collection( 'my_custom_collection', array( 'title' => 'My Block', 'icon' => 'smiley', 'category' => 'widgets' ) );

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

複数のメタデータを一度に登録する例です。

wp_register_core_block_metadata_collection( 'multiple_blocks', array( array( 'title' => 'Block 1', 'icon' => 'star' ), array( 'title' => 'Block 2', 'icon' => 'heart' ) ) );

例3: カスタムブロックのメタデータを登録

カスタムブロックのメタデータを登録する例です。

wp_register_core_block_metadata_collection( 'custom_block', array( 'title' => 'Custom Block', 'icon' => 'admin-site', 'category' => 'design' ) );

例4: メタデータにカスタム属性を追加

メタデータにカスタム属性を追加する例です。

wp_register_core_block_metadata_collection( 'block_with_attributes', array( 'title' => 'Block with Attributes', 'icon' => 'admin-tools', 'attributes' => array( 'customAttribute' => array( 'type' => 'string' ) ) ) );

例5: メタデータにサポート機能を追加

メタデータにサポート機能を追加する例です。

wp_register_core_block_metadata_collection( 'block_with_supports', array( 'title' => 'Block with Supports', 'icon' => 'admin-generic', 'supports' => array( 'align' => true, 'color' => true ) ) );

例6: メタデータにカスタムスタイルを追加

メタデータにカスタムスタイルを追加する例です。

wp_register_core_block_metadata_collection( 'block_with_styles', array( 'title' => 'Block with Styles', 'icon' => 'admin-appearance', 'styles' => array( array( 'name' => 'default', 'label' => 'Default' ), array( 'name' => 'custom', 'label' => 'Custom' ) ) ) );

注意点

  • メタデータコレクションの名前は一意である必要があります。
  • メタデータの配列は、ブロックエディタで認識される形式である必要があります。
  • この関数は、ブロックエディタが初期化される前に呼び出す必要があります。

関連機能：