register_block_type() の使い方|説明・引数・注意点

説明

register_block_type() は、独自のブロックを登録する関数です。

基本構文

register_block_type( string|WP_Block_Type $block_type, array $args = array() ): WP_Block_Type|false

引数

  • $block_type:ブロック名、または block.json のパス
  • $args:render_callback、attributes など

戻り値

WP_Block_Type。失敗時は false。

使い方(サンプル)

add_action( 'init', function() {
	register_block_type( __DIR__ . '/build/my-block' );
} );

注意点

  • init フックで呼びます。
  • 現在は block.json を使って登録するのが推奨です。

実務での使いどころ

  • 独自のブロックを、PHP側で登録するとき(block.json を使う方法が、推奨)。
  • 動的なブロック(render_callback)を、登録するとき。

よくあるミスと対処

  • init フックの外で呼んでいる。
  • block.json のパスを、間違えている。ファイルや、フォルダの場所を、確認する。
  • ブロックの名前を、名前空間/名前 の形式にしていない。
  • PHP側で登録しただけで、エディター側(JavaScript)の登録が、ない。

NG例

register_block_type( __DIR__ . '/build' ); // init の外で呼んでいる

OK例

add_action( 'init', function () {
	register_block_type( __DIR__ . '/build/my-block' ); // block.json があるフォルダ
} );

使い分け早見表

関数 役割
register_block_type() ブロックを、登録する
register_block_style() ブロックに、スタイルのバリエーションを、追加する
register_block_pattern() ブロックパターンを、登録する

関連項目

register_block_style()、register_block_pattern()

公式リファレンス:register_block_type() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました