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

お勧め

meta_compare_key使ってみた（2019年3月19日 更新）

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する（2012年3月15日 更新）

投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える（2014年9月12日 更新）

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。