register_block_pattern() の使い方｜説明・引数・注意点

説明

基本構文

register_block_pattern( string $pattern_name, array $pattern_properties ): bool

引数

• $pattern_name：パターン名（名前空間付き）
• $pattern_properties：title、content、categories など

戻り値

登録できたら true。

使い方（サンプル）

register_block_pattern( 'my-theme/hero', array(
	'title'   => 'ヒーロー',
	'content' => '<!-- wp:paragraph --><p>Hello</p><!-- /wp:paragraph -->',
) );

注意点

• init フックで呼びます。
• パターンをまとめるカテゴリーは register_block_pattern_category() で登録します。

実務での使いどころ

• よく使う、ブロックの組み合わせ（ヒーロー、料金表など）を、テンプレートとして、登録するとき。

よくあるミスと対処

• content が、ブロックのマークアップ（<!-- wp:... -->）になっていない。
• パターン名を、名前空間/名前 の形式にしていない。
• init フックの外で呼んでいる。
• 存在しない、カテゴリーを指定している。

NG例

register_block_pattern( 'hero', array( 'title' => 'ヒーロー', 'content' => '<div>見出し</div>' ) ); // 名前空間がなく、ブロックのマークアップでもない

OK例

add_action( 'init', function () {
	register_block_pattern( 'my-theme/hero', array(
		'title'   => 'ヒーロー',
		'content' => '<!-- wp:heading --><h2 class="wp-block-heading">見出し</h2><!-- /wp:heading -->',
	) );
} );

使い分け早見表

関連項目

register_block_type()、register_block_style()

公式リファレンス：register_block_pattern() | Function | WordPress Developer Resources