_register_theme_block_patterns()


WordPressの_register_theme_block_patterns()関数は、テーマ内でブロックパターンを登録するために使用されます。この関数を使うことで、カスタムブロックパターンを簡単に追加できます。

構文

_register_theme_block_patterns( string $pattern_name, array $pattern_properties );

引数の説明:

  • $pattern_name(string) — 登録するブロックパターンの名前。
  • $pattern_properties(array) — ブロックパターンのプロパティを含む配列。

例1: 基本的なブロックパターンの登録

これは、シンプルなブロックパターンを登録する例です。

_register_theme_block_patterns( 'my-theme/my-pattern', array( 'title' => '私のパターン', 'content' => '<!-- wp:paragraph --><p>こんにちは、世界！</p><!-- /wp:paragraph -->' ) );

例2: カテゴリーを指定してブロックパターンを登録

カテゴリーを指定してブロックパターンを登録する例です。

_register_theme_block_patterns( 'my-theme/my-category-pattern', array( 'title' => 'カテゴリーパターン', 'content' => '<!-- wp:heading --><h2>見出し</h2><!-- /wp:heading -->', 'categories' => array( 'text' ) ) );

例3: 複数のブロックを含むパターン

複数のブロックを含むパターンを登録する例です。

_register_theme_block_patterns( 'my-theme/multi-block-pattern', array( 'title' => '複数ブロックパターン', 'content' => '<!-- wp:paragraph --><p>段落1</p><!-- /wp:paragraph --><!-- wp:paragraph --><p>段落2</p><!-- /wp:paragraph -->' ) );

例4: アイコンを指定してブロックパターンを登録

アイコンを指定してブロックパターンを登録する例です。

_register_theme_block_patterns( 'my-theme/icon-pattern', array( 'title' => 'アイコンパターン', 'content' => '<!-- wp:image --><img src="image.png" alt="画像"><!-- /wp:image -->', 'icon' => 'smiley' ) );

例5: 説明文を追加してブロックパターンを登録

説明文を追加してブロックパターンを登録する例です。

_register_theme_block_patterns( 'my-theme/description-pattern', array( 'title' => '説明付きパターン', 'content' => '<!-- wp:paragraph --><p>説明付きのパターンです。</p><!-- /wp:paragraph -->', 'description' => 'これは説明文です。' ) );

例6: キーワードを指定してブロックパターンを登録

キーワードを指定してブロックパターンを登録する例です。

_register_theme_block_patterns( 'my-theme/keyword-pattern', array( 'title' => 'キーワードパターン', 'content' => '<!-- wp:paragraph --><p>キーワード付きのパターンです。</p><!-- /wp:paragraph -->', 'keywords' => array( 'キーワード1', 'キーワード2' ) ) );

例7: ブロックパターンの登録を条件付きで行う

特定の条件下でのみブロックパターンを登録する例です。

if ( function_exists( '_register_theme_block_patterns' ) ) { _register_theme_block_patterns( 'my-theme/conditional-pattern', array( 'title' => '条件付きパターン', 'content' => '<!-- wp:paragraph --><p>条件付きで登録されたパターンです。</p><!-- /wp:paragraph -->' ) ); }

注意点

  • ブロックパターンを登録する際は、テーマのfunctions.phpファイルにコードを追加します。
  • ブロックパターンの名前は一意である必要があります。
  • ブロックパターンのコンテンツは、有効なブロックHTMLである必要があります。

関連機能：