register_block_template

（6.7.0以降）
register_block_template - ブロックテンプレートを登録する

説明

WP_Block_Template|WP_Error register_block_template( string $template_name [ , array $args = array() ] )
ブロックテンプレートを登録する。

パラメータ

  • $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"} /-->'
	)
);

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/block-template.php

最終更新 : 2024年11月13日 10:11

関連

参考

Code Reference: register_block_template

お勧め

スマートフォン向けの振り分けを自前で行う（2012年1月23日 更新）

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。

ショートコードを含んだページを表示する前に何か処理する（2014年5月28日 更新）

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす（2019年5月24日 更新）

/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。

管理者ページに文言を表示する（2012年4月19日 更新）

お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。

5.3の機能強化：ユーザーパスワードの表示と非表示（2019年9月30日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Toggle password view」という項目。「Other Changes for Developers」の見出しの中ということもあり、ちょっと調べてみた。