acf_register_block()

ACFのacf_register_block()関数は、Gutenbergエディターで使用できるカスタムブロックを登録するために使用される。

シンタックス

acf_register_block( array $settings );

• $settings (array) — ブロックの設定情報を含む配列

例1. 基本的なブロック登録

次のコードはacf_register_block()を使用してシンプルなブロックを登録する。

acf_register_block( array(
    'name' => 'example_block',
    'title' => 'サンプルブロック',
    'render_template' => 'block-template.php'
) );

例2. カテゴリーを指定して登録

ブロックのカテゴリーを指定して登録する方法。

acf_register_block( array(
    'name' => 'custom_category_block',
    'title' => 'カテゴリー付きブロック',
    'category' => 'formatting',
    'render_template' => 'block-template.php'
) );

例3. アイコンを設定する

アイコンを指定することで、ブロックの識別が容易になる。

acf_register_block( array(
    'name' => 'icon_block',
    'title' => 'アイコン付きブロック',
    'icon' => 'admin-comments',
    'render_template' => 'block-template.php'
) );

例4. スクリプトやスタイルを指定する

ブロックに特定のスクリプトやスタイルを適用する。

acf_register_block( array(
    'name' => 'styled_block',
    'title' => 'スタイル付きブロック',
    'enqueue_style' => 'path/to/style.css',
    'enqueue_script' => 'path/to/script.js',
    'render_template' => 'block-template.php'
) );

例5. 条件を追加する

特定の条件でブロックを登録する。

if( function_exists('acf_register_block') ) {
    acf_register_block( array(
        'name' => 'conditional_block',
        'title' => '条件付きブロック',
        'render_template' => 'block-template.php'
    ) );
}

注意点

• acf_register_block()を使用するには、Advanced Custom Fields PROが必要。
• 関数はinitアクション内で呼び出す。