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

説明

register_block_style() は、既存のブロックに、選択可能なスタイルバリエーションを追加する関数です。

基本構文

register_block_style( string|string[] $block_name, array $style_properties ): bool

引数

  • $block_name:ブロック名
  • $style_properties:name、label など

戻り値

登録できたら true。

使い方(サンプル)

register_block_style( 'core/quote', array(
	'name'  => 'fancy',
	'label' => '装飾付き',
) );

注意点

  • スタイル名に対応するCSSクラス is-style-{name} を、別途CSSで定義します。

実務での使いどころ

  • 既存のブロック(段落、画像など)に、独自のスタイルのバリエーションを、追加するとき。

よくあるミスと対処

  • ブロック名を、名前空間なしで指定している。core/paragraph のように、指定する。
  • init フックの外で呼んでいる。
  • スタイルの name に対応する、CSSのクラス(is-style-名前)を、用意していない。

NG例

register_block_style( 'paragraph', array( 'name' => 'note', 'label' => '注釈' ) ); // 名前空間がない

OK例

add_action( 'init', function () {
	register_block_style( 'core/paragraph', array(
		'name'  => 'note',
		'label' => '注釈',
	) );
} );
/* CSS:.is-style-note { ... } */

使い分け早見表

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

関連項目

register_block_type()、wp_enqueue_block_style()

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

コメント

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