register_block_core_cover()


WordPressのregister_block_core_cover()関数は、カバーブロックを登録するために使用されます。この関数は、ブロックエディタでカバー画像やビデオを表示するためのブロックを追加します。

構文

register_block_core_cover( array $args );

引数の説明:

  • $args(array) — ブロックの設定を定義する配列。以下のキーを含むことができます:
    • 'name'(string) — ブロックの名前。
    • 'title'(string) — ブロックのタイトル。
    • 'description'(string) — ブロックの説明。
    • 'category'(string) — ブロックが属するカテゴリ。
    • 'icon'(string) — ブロックのアイコン。
    • 'keywords'(array) — ブロックの検索キーワード。
    • 'supports'(array) — ブロックがサポートする機能。

例1: 基本的なカバーブロックの登録

カバーブロックを登録する基本的な例です。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'category' => 'common', 'icon' => 'format-image' ) );

例2: カスタムアイコンを使用したカバーブロック

カスタムアイコンを指定してカバーブロックを登録します。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'category' => 'common', 'icon' => 'camera' ) );

例3: カバーブロックにキーワードを追加

ブロックに検索キーワードを追加します。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'category' => 'common', 'icon' => 'format-image', 'keywords' => array( '画像', 'ビデオ', '背景' ) ) );

例4: カバーブロックのサポート機能を設定

ブロックがサポートする機能を指定します。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'category' => 'common', 'icon' => 'format-image', 'supports' => array( 'align' => true, 'html' => false ) ) );

例5: カバーブロックの説明を追加

ブロックに説明を追加します。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'description' => '背景画像やビデオを追加するためのブロックです。', 'category' => 'common', 'icon' => 'format-image' ) );

例6: カバーブロックを特定のカテゴリに追加

ブロックを特定のカテゴリに追加します。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'category' => 'media', 'icon' => 'format-image' ) );

例7: カバーブロックのデフォルト設定を変更

ブロックのデフォルト設定を変更します。

register_block_core_cover( array( 'name' => 'core/cover', 'title' => 'カバー', 'category' => 'common', 'icon' => 'format-image', 'defaults' => array( 'align' => 'wide', 'overlayColor' => '#000000' ) ) );

注意点

  • この関数は、ブロックエディタが有効な場合にのみ動作します。
  • 引数の配列に不正な値が含まれている場合、ブロックが正しく登録されないことがあります。
  • カバーブロックは、背景画像やビデオを表示するために使用されるため、適切なスタイル設定が必要です。

関連機能：