register_block_template

パラメータ

• $template_name
  ブロックテンプレート名（plugin-uri//template-name）を指定。
• $args
  ブロックテンプレートのプロパティを連想配列で指定。

  キー	データ型	内容
  'title'	string	テンプレート名
  'description'	array	テンプレートの説明
  'content'	string	テンプレートの内容（HTML）
  'post_types'	string[]	投稿タイプ名の配列

返り値

登録できた場合はブロックテンプレート（WP_Block_Templateオブジェクト）を返す。登録できなかった場合はWP_Errorオブジェクトを返す。

注意

パラメータ$template_nameは「ネームスペース名//テンプレート名」の書式となり、ネームスペース名とテンプレート名は「//」で連結される。またネームスペース名とテンプレート名は英小文字および数字と-（ハイフン）のみが使用でき、英大文字やそのほかの記号も使用できない。

パラメータ$args['title']が省略された場合、パラメータ$template_nameの内容が適用される。

使用例

• ブロックテンプレートを登録する

  $template = register_block_template(
  	'my-plugin//example',
  	array(
  		'title'       => __( 'Example', 'plugin-domain' ),
  		'description' => __( 'An example block template', 'plugin-domain' ),
  		'content'     => '
  			<!-- wp:template-part {"slug":"header","area":"header","tagName":"header"} /-->
  			<div class="wp-block-group">
  				<!-- wp:paragraph -->
  				<p>A block template.</p>
  				<!-- /wp:paragraph -->
  			</div>
  			<!-- wp:template-part {"slug":"footer","area":"footer","tagName":"footer"} /-->'
  	)
  );
  

フィルター

アクション

ソースファイル