register_block_pattern_category()


WordPressのregister_block_pattern_category()関数は、ブロックパターンのカテゴリーを登録するために使用されます。カスタムブロックパターンを整理する際に便利です。

構文

register_block_pattern_category( string $category_name, array $category_properties );

引数の説明:

  • $category_name(string)—登録するカテゴリーのスラッグ
  • $category_properties(array)—カテゴリーのプロパティ(labelが必須)

例1:基本的なカテゴリー登録

「my-custom-patterns」というカテゴリーを登録します。

register_block_pattern_category('my-custom-patterns',array('label'=>'カスタムパターン'));

例2:日本語ラベルを使用

日本語でカテゴリー名を設定します。

register_block_pattern_category('japanese-patterns',array('label'=>'日本語パターン'));

例3:複数カテゴリーを一度に登録

複数のカテゴリーをループで登録します。

foreach(['cat1','cat2']as $cat){register_block_pattern_category($cat,array('label'=>$cat.'カテゴリー'));}

例4:テーマのfunctions.phpで使用

テーマ起動時にカテゴリーを登録します。

add_action('init',function(){register_block_pattern_category('theme-patterns',array('label'=>'テーマパターン'));});

例5:既存カテゴリーの上書き

既存のカテゴリーを変更します。

unregister_block_pattern_category('core/buttons');register_block_pattern_category('core/buttons',array('label'=>'新しいボタン'));

例6:プラグイン内での使用

プラグインからカテゴリーを追加します。

register_activation_hook(__FILE__,function(){register_block_pattern_category('plugin-patterns',array('label'=>'プラグインパターン'));});

例7:国際化対応

翻訳可能なラベルを設定します。

register_block_pattern_category('i18n-patterns',array('label'=>__('International Patterns','text-domain')));

注意点

  • カテゴリー名は一意である必要があります
  • initフック以降で実行してください
  • 既存のコアカテゴリーを変更する場合は注意が必要です

関連機能: