register_block_core_list()


WordPressの関数register_block_core_list()は、ブロックエディタで使用されるリストブロックを登録するための関数です。

シンタックス

register_block_core_list( string $name, array $args = array() );

引数の説明:

  • $name (string) — 登録するブロックの名前。通常は、コアブロック名が使用されます。
  • $args (array) — ブロックの設定を変更するための引数の配列。オプションで指定できます。

例1: リストブロックを登録

以下は、カスタムリストブロックを登録する基本的なコードです。

<?php
function my_custom_block() {
    register_block_core_list( 'my/custom-list' );
}
add_action( 'init', 'my_custom_block' );
?>

例2: 引数で設定を追加

リストブロックの設定を変更する方法を示すコードです。

<?php
function my_custom_block_with_args() {
    register_block_core_list( 'my/custom-list', array(
        'render_template' => 'template-parts/blocks/custom-list.php',
    ) );
}
add_action( 'init', 'my_custom_block_with_args' );
?>

例3: コンテンツのリストアイテムをカスタマイズ

リストアイテムをカスタマイズするためのコードです。

<?php
function my_custom_list_item() {
    register_block_core_list( 'my/custom-list-item', array(
        'render_template' => 'template-parts/blocks/custom-list-item.php',
    ) );
}
add_action( 'init', 'my_custom_list_item' );
?>

例4: ブロックのカスタム属性を追加

カスタム属性を使ってブロックを登録するコードです。

<?php
function my_custom_list_with_attributes() {
    register_block_core_list( 'my/custom-list', array(
        'attributes' => array(
            'customAttribute' => array(
                'type' => 'string',
                'default' => 'value',
            ),
        ),
    ) );
}
add_action( 'init', 'my_custom_list_with_attributes' );
?>

例5: コアリストブロックを変更

コアのリストブロックをカスタマイズするコード例です。

<?php
function my_custom_core_list_block() {
    register_block_core_list( 'core/list', array(
        'render_template' => 'template-parts/blocks/custom-list-core.php',
    ) );
}
add_action( 'init', 'my_custom_core_list_block' );
?>

注意点:

  • register_block_core_list()は、ブロックエディタ内で使用されるリストを登録する関数です。
  • カスタムテンプレートファイルを指定する際は、適切なパスを指定する必要があります。
  • 引数$argsに渡す設定値に注意し、適切なブロック属性を指定してください。

関連機能：